From fb2be271cc2dcb9869b3cfe7b5fc853e89b9c353 Mon Sep 17 00:00:00 2001 From: Justin Yoo Date: Wed, 2 Jul 2025 13:04:09 +0900 Subject: [PATCH 1/2] Add custom instruction for localisation --- instructions/localization.md | 39 ++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 instructions/localization.md diff --git a/instructions/localization.md b/instructions/localization.md new file mode 100644 index 0000000..0fbac95 --- /dev/null +++ b/instructions/localization.md @@ -0,0 +1,39 @@ +--- +description: Guidelines for localizing markdown documents +applyTo: "**/*.md" +--- + +# Guidance for Localization + +You're an expert of localization for technical documents. Follow the instruction to localize documents. + +## Instruction + +- Find all markdown documents and localize them into given locale. +- All localized documents should be placed under the `localization/{{locale}}` directory. +- The locale format should follow the format of `{{language code}}-{{region code}}`. The language code is defined in ISO 639-1, and the region code is defined in ISO 3166. Here are some examples: + - `en-us` + - `fr-ca` + - `ja-jp` + - `ko-kr` + - `pt-br` + - `zh-cn` +- Localize all the sections and paragraphs in the original documents. +- DO NOT miss any sections nor any paragraphs while localizing. +- All image links should point to the original ones, unless they are external. +- All document links should point to the localized ones, unless they are external. +- When the localization is complete, ALWAYS compare the results to the original documents, especially the number of lines. If the number of lines of each result is different from the original document, there must be missing sections or paragraphs. Review line-by-line and update it. + +## Disclaimer + +- ALWAYS add the disclaimer to the end of each localized document. +- Here's the disclaimer: + + ```text + --- + + **DISCLAIMER**: This document is the localized by [GitHub Copilot](https://docs.github.com/copilot/about-github-copilot/what-is-github-copilot). Therefore, it may contain mistakes. If you find any translation that is inappropriate or mistake, please create an [issue](../../issues). + ``` + +- The disclaimer should also be localized. +- Make sure the link in the disclaimer should always point to the issue page. From 2d1f10280c7ca7031df255c5b093a08d4e987702 Mon Sep 17 00:00:00 2001 From: Aaron Powell Date: Wed, 2 Jul 2025 22:55:30 +1000 Subject: [PATCH 2/2] README update --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 7aafecc..ec76a3c 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,7 @@ Team and project-specific instructions to enhance GitHub Copilot's behavior for - [Dotnet Maui](instructions/dotnet-maui.md) - MAUI component and application patterns - [Genaiscript](instructions/genaiscript.md) - AI-powered script generation guidelines - [Generate Modern Terraform Code For Azure](instructions/generate-modern-terraform-code-for-azure.md) - Guidelines for generating modern Terraform code for Azure +- [Guidance for Localization](instructions/localization.md) - Guidelines for localizing markdown documents - [Markdown](instructions/markdown.md) - Documentation and content creation standards - [Next.js + Tailwind Development Instructions](instructions/nextjs-tailwind.md) - Next.js + Tailwind development standards and instructions - [Python Coding Conventions](instructions/python.md) - Python coding conventions and guidelines