Address feedback on localization guidance for automated PRs#40800
Conversation
|
@copilot - why are so many unrelated localization files in this pr? I just want the guidance so future localization update PRs don't get a million comments about "you shouldn't modify this file" |
…-feedback-localization-guidance
Those files were showing up because this branch was based before |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
There was a problem hiding this comment.
Pull request overview
This PR updates contributor and Copilot guidance around localization to explicitly exempt automated localization-service pull requests from the “file an issue; don’t directly edit non-en-US localized files” rule, keeping automated localization pipeline behavior consistent with contributor-facing guidance.
Changes:
- Update
CONTRIBUTING.mdlocalization section to add an explicit exemption for automated localization-service PRs. - Update
.github/copilot-instructions.mdlocalization guidance with the same exemption.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Adds an explicit exemption in localization/translation guidance for automated localization-service PRs. |
| .github/copilot-instructions.md | Aligns Copilot localization guidance with CONTRIBUTING by exempting automated localization-service PRs. |
| If you spot a bad, missing, or incorrect translation in WSL's UI, **please file an issue** describing the problem (which language, what string, and what it should say) rather than opening a pull request. | ||
|
|
||
| WSL's localized files are generated by a separate localization team and are regenerated downstream, so any translation edits made in a pull request here would be overwritten and cannot be merged. This covers the per-locale UI strings (`localization/strings/<locale>/Resources.resw`) and the per-locale Intune/group-policy templates (`intune/<locale>/WSL.adml`). Filing an issue lets us route the fix to the team that owns those translations. The `en-US` source files (`localization/strings/en-US/Resources.resw`, `intune/en-US/WSL.adml`, and the language-neutral `intune/WSL.admx`) are the exception, since those originate in this repository. | ||
| WSL's localized files are generated by a separate localization team and are regenerated downstream, so any translation edits made in a pull request here would be overwritten and cannot be merged. This covers the per-locale UI strings (`localization/strings/<locale>/Resources.resw`) and the per-locale Intune/group-policy templates (`intune/<locale>/WSL.adml`). Filing an issue lets us route the fix to the team that owns those translations. The `en-US` source files (`localization/strings/en-US/Resources.resw`, `intune/en-US/WSL.adml`, and the language-neutral `intune/WSL.admx`) are the exception, since those originate in this repository. This guidance does not apply to automated localization-service pull requests that are generated by that pipeline. |
| - All new user-facing strings must have entries in `localization/strings/en-US/Resources.resw` | ||
| - In Resources.resw comments, use `{Locked="..."}` to prevent translation of `.wslconfig` property key names | ||
| - Localized files are generated by a separate localization team and regenerated downstream, so translation edits in a GitHub PR cannot be merged (they would be overwritten). This covers the per-locale `localization/strings/<locale>/Resources.resw` UI strings and the per-locale `intune/<locale>/WSL.adml` policy templates (anything other than the `en-US` sources and the neutral `intune/WSL.admx`). Filing a GitHub issue is the correct path for contributors; see `CONTRIBUTING.md`. | ||
| - Localized files are generated by a separate localization team and regenerated downstream, so translation edits in a GitHub PR cannot be merged (they would be overwritten). This covers the per-locale `localization/strings/<locale>/Resources.resw` UI strings and the per-locale `intune/<locale>/WSL.adml` policy templates (anything other than the `en-US` sources and the neutral `intune/WSL.admx`). Filing a GitHub issue is the correct path for contributors; see `CONTRIBUTING.md`. Ignore this guidance for automated localization-service PRs that are generated by that pipeline. |
Summary of the Pull Request
This PR updates localization guidance to clarify that automated localization-service pull requests are exempt from the contributor-facing rule about filing issues instead of directly editing non-en-US localized files. It also updates branch ancestry so the PR diff only contains the guidance changes.
PR Checklist
Detailed Description of the Pull Request / Additional comments
CONTRIBUTING.mdlocalization guidance to explicitly exclude automated localization-service PRs generated by the localization pipeline..github/copilot-instructions.mdlocalization guidance with the same exemption so automated PR handling is consistent.origin/masterinto this branch so unrelated localeResources.reswfile changes from the stacked base are no longer included in this PR diff.Validation Steps Performed
python3 tools/devops/validate-copyright-headers.pypython3 tools/devops/validate-localization.pyorigin/mastercontains only:CONTRIBUTING.md.github/copilot-instructions.md