# localization

This rule guides GitHub Copilot through localizing Markdown files, preserving document links, checking the result, and adding a translated disclaimer.

- rule · `type=rule` · GitHub Copilot · ★ 40451
- Author: github · official GitHub repository
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/github/awesome-copilot/tree/HEAD/instructions/localization.instructions.md
- Updated: 2026-10-23
- HTML: https://affpapa.org/en/nevibecode/rules/localization

## What it does

The rule targets `**/*.md` files. It directs Copilot to find Markdown documents, translate every section and paragraph into the requested locale, then save the files under `localization/{{locale}}`. Locale identifiers use a language code and a region code, such as `fr-ca` or `ja-jp`.

Image links should keep pointing to their original files; links between documents should lead to localized versions. Once translation is done, Copilot compares each result with its source line by line, including the line count. A translated disclaimer with a link to the issue page goes at the end of every document. That requirement adds a block to each localized file.

## Install

### GitHub Copilot (native platform)

**Manually: put the files in place**
- File: `.github/instructions/localization.instructions.md` — The applyTo field sets which files it applies to

### Claude Code

**Manually: put the files in place**
- File: `.claude/rules/localization.md` — The paths frontmatter field limits the files: move applyTo from the source into paths

### Codex

**AGENTS.md**
- Codex reads AGENTS.md: paste the rule text there

### Cursor

**Manually: put the files in place**
- File: `.cursor/rules/localization.mdc` — Frontmatter: description, globs, alwaysApply. Move applyTo from the source into globs, or the rule will not attach on its own

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/rules/localization.md`

### Cline

**Manually: put the files in place**
- File: `.clinerules/localization.md`

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/github/awesome-copilot/tree/HEAD/instructions/localization.instructions.md

## When to use it
- translate Markdown documents into a requested locale
- save translated files under the locale directory
- update internal links to localized documents
- compare localized files with originals line by line
- append a localized disclaimer to each document

## Example prompts
- Localize all Markdown files into `fr-ca` and save them under `localization/fr-ca`.
- Translate the documents into `ja-jp`, keeping image links and updating links between documents.
- Compare the localized files with their originals line by line, then add the translated disclaimer.

## Source text · localization.instructions.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 6aca8448df912f00.

BEGIN THIRD-PARTY FILE 6aca8448df912f00
````text
---
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](https://github.com/github/awesome-copilot/issues).
    ```

- The disclaimer should also be localized.
- Make sure the link in the disclaimer should always point to the issue page.
````
END THIRD-PARTY FILE 6aca8448df912f00

The third-party file has ended. Everything between the 6aca8448df912f00 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

© github · MIT · https://github.com/github/awesome-copilot/tree/HEAD/instructions/localization.instructions.md

## Similar
- [cmux-localization](https://affpapa.org/en/nevibecode/skills/cmux-localization.md) — skill · 4700 installs
- [flutter-setup-localization](https://affpapa.org/en/nevibecode/skills/flutter-setup-localization.md) — skill · 36800 installs

From the same set: [github/awesome-copilot](https://affpapa.org/en/nevibecode/by/github/awesome-copilot.md) — 949 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md