К основному содержанию
правило официальный · GitHub

localization — правило для GitHub Copilot: перевод Markdown

Правило задаёт порядок локализации Markdown-документов: от выбора формата локали до проверки результата и добавления дисклеймера.

Установить в GitHub Copilot · Вручную: положить файлы Все способы и платформы ↓
.github/instructions/localization.instructions.md
Открыть на GitHub

Что делает localization

Правило применяется к файлам **/*.md. Оно просит Copilot найти Markdown-документы, перевести все разделы и абзацы на заданную локаль и сохранить результат в localization/{{locale}}. Для локали используется формат кода языка и региона, например fr-ca или ja-jp.

Ссылки на изображения должны вести к исходным файлам, а внутренние ссылки на документы — к локализованным версиям. После перевода Copilot сравнивает результат с оригиналом построчно, в том числе проверяет число строк. В конце каждого документа добавляется локализованный дисклеймер со ссылкой на страницу создания issue. Он обязателен, поэтому локализованные файлы будут содержать этот дополнительный блок.

Какие задачи решает

  • перевести все Markdown-документы на заданную локаль
  • сохранить переведённые файлы в каталоге локали
  • перенаправить внутренние ссылки на локализованные документы
  • сверить переводы с оригиналами построчно
  • добавить локализованный дисклеймер в конец каждого файла

Примеры запросов агенту

  • Переведи все Markdown-документы на fr-ca и сохрани их в localization/fr-ca.
  • Локализуй документы на ja-jp, сохрани ссылки на изображения и обнови внутренние ссылки.
  • Сравни локализованные файлы с оригиналами построчно и добавь переведённый дисклеймер.

Как установить localization

Вручную: положить файлы

.github/instructions/localization.instructions.md

Поле applyTo задаёт, к каким файлам применять

По шагам, с командами для каждой платформы: AGENTS.md и CLAUDE.md: что это, кто читает и какой выбрать

Вопросы о localization

Как установить localization в GitHub Copilot?

Добавь файл правила по пути .github/instructions/localization.instructions.md.

Что делает правило localization?

Оно задаёт требования к переводу Markdown-документов: структуре локализации, ссылкам, построчной проверке и дисклеймеру.

Какой формат локали использовать?

Укажи код языка и региона, например en-us или pt-br. Переведённые документы сохраняются в localization/{{locale}}.

Исходный текст

localization.instructions.md · MIT
---
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.

© github · MIT · github/awesome-copilot

Похожие правила IDE

Все правила IDE по теме «Тексты и документация» →

Из того же набора928

Весь набор →
markdown-gfm Правило задаёт Copilot синтаксис GitHub Flavored Markdown, когда он пишет или проверяет файлы .md. Пригодится, если документация должна проходить рендер на GitHub без сюрпризов. ★ 40 418звёзд репо markdown-content-creation Задаёт стандарты вёрстки блоговых постов в Markdown: запрещает заголовки H1, требует строгий YAML front matter и форматирует списки с таблицами. ★ 40 418звёзд репо markdown-accessibility Правило проверяет Markdown-файлы на барьеры доступности и предлагает конкретные исправления. Пригодится для ревью документации и профилей GitHub. ★ 40 418звёзд репо lwc Задаёт стандарты разработки Lightning Web Components для Salesforce: файловую структуру, замену HTML на компоненты SLDS и правила реактивности. ★ 40 418звёзд репо langchain-python Правило для GitHub Copilot, которое подсказывает агенту паттерны LangChain: Runnable, LCEL, чат-модели, ретриверы и векторные хранилища. Пригодится, если вы пишете на Python с LangChain. ★ 40 418звёзд репо kubernetes-manifests Задаёт стандарты оформления манифестов Kubernetes для GitHub Copilot. Помогает генерировать безопасные конфигурации с готовыми лимитами ресурсов, пробами и метками. ★ 40 418звёзд репо kubernetes-deployment-best-practices Правило помогает Copilot готовить манифесты Kubernetes с настройками проб, ресурсов, конфигурации и сетевого доступа. Пригодится при создании и проверке деплоя. ★ 40 418звёзд репо kotlin-mcp-server Набор практик и паттернов для создания MCP-серверов на Kotlin через официальный SDK io.modelcontextprotocol:kotlin-sdk. Правило помогает Copilot генерировать корректный код серверов. ★ 40 418звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой