docs: require translation sync in the same PR as English changes - #242
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the contributor/agent guidelines (AGENTS.md) to explicitly require keeping translated READMEs in sync whenever English documentation (or code changes affecting documented behavior/CLI output/tables) changes, matching the acceptance criteria in issue #241.
Changes:
- Adds a new Documentation & Translations rule under Working Rules requiring translation updates in the same PR.
- Clarifies that the rule applies to code changes that impact documented behavior, CLI output, or ecosystem/package tables.
- Adds a fallback process (“translation pending” note + tracking issue) when same-PR translation cannot be completed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ### Documentation & Translations | ||
| - When a change touches `README.md` or any English documentation, update the translated READMEs (`README.ko.md`, `README.ja.md`, `README.zh-CN.md`) **in the same PR** so translations never drift from the English source. | ||
| - This applies to any code change that alters documented behavior, CLI output, or the ecosystem/package table — not just direct edits to prose. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Documentation & Translations rule to
AGENTS.mdunder## Working Rules: whenever a change touchesREADME.mdor English docs (including code changes that alter documented behavior, CLI output, or the ecosystem table), the translated READMEs (README.ko.md/README.ja.md/README.zh-CN.md) must be updated in the same PR.Codifies the practice we just applied when syncing the Ecosystem tables.
Closes #241