docs: require English for all repository artifacts - #865
Conversation
Make the English-only convention explicit so any contributor or coding agent picks it up. Add a Language section to AGENTS.md (the tool-agnostic guidelines file) and mirror a one-line pointer in CLAUDE.md (auto-loaded by Claude Code), covering code, comments, identifiers, commit messages, PR titles/descriptions, issues and docs. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01X5uNqd26cC88p5HVqErRDU
WalkthroughThis PR adds documentation-only changes requiring all repository content—code, comments, commit messages, PRs, issues, and docs—to be written in English. A new "Language" section is added to AGENTS.md, and a "Conventions" section referencing AGENTS.md is added to CLAUDE.md. ChangesDocumentation policy update
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CLAUDE.md`:
- Line 7: The Markdown emphasis in CLAUDE.md uses bold asterisks in the
“Language” entry, which conflicts with the repo’s `.md` formatting rule. Update
that line to use underscore emphasis instead of asterisks, keeping the same
wording and locating it in the Language section near the top of the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
|
|
||
| ## Conventions | ||
|
|
||
| - **Language:** everything committed to this repo (code, comments, commit messages, PRs, issues, docs) must be in English. See AGENTS.md. |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Use underscores instead of bold asterisks here.
**Language:** violates the Markdown rule for .md files. As per coding guidelines, use underscores for emphasis (_text_) instead of asterisks (*text*).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@CLAUDE.md` at line 7, The Markdown emphasis in CLAUDE.md uses bold asterisks
in the “Language” entry, which conflicts with the repo’s `.md` formatting rule.
Update that line to use underscore emphasis instead of asterisks, keeping the
same wording and locating it in the Language section near the top of the
document.
Source: Coding guidelines
2 participants
What
Makes the English-only convention explicit so any contributor — human or coding agent — picks it up automatically.
AGENTS.md: new## Languagesection stating that all repository artifacts (source code, comments, identifiers, commit messages, PR titles/descriptions, issues, docs) must be written in English, regardless of the language used to converse with a contributor.CLAUDE.md: a one-line pointer under a## Conventionsheading, since Claude Code auto-loads this file.Why
The rule was implicit.
AGENTS.mdis the tool-agnostic guidelines file most coding agents read, so it is the canonical home;CLAUDE.mdmirrors a short pointer to guarantee coverage for Claude Code sessions whether or notAGENTS.mdis loaded.Docs-only change: no runtime, build, or test impact.
🤖 Generated with Claude Code
https://claude.ai/code/session_01X5uNqd26cC88p5HVqErRDU
Generated by Claude Code
Summary by CodeRabbit