Skip to content

Update AGENTS.md #1701

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
st0012 merged 2 commits into from
May 7, 2026
+2 −0
Merged

Update AGENTS.md #1701

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49abb88
Document PR description style for AI-assisted contributions
claude May 7, 2026
134497b
AGENTS.md: require fork master to be synced with ruby/rdoc before bra…
claude May 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,3 +405,5 @@ For server-specific E2E testing (endpoint checks, live-reload verification, file
4. **Use `rake rerdoc`** to regenerate documentation (not just `rdoc`)
5. **Verify generated files** with `rake verify_generated`
6. **Don't edit generated files** directly (in `lib/rdoc/markdown/` and `lib/rdoc/rd/`)
7. **Pull request descriptions** must be concise. Use 2–4 short paragraphs explaining the context, why the change is correct, and any notable side effect. Do not include a "Test plan" section. Do not append a Claude Code session link or any AI attribution.
8. **Sync the fork before branching**: when this repository is a fork of `ruby/rdoc`, fast-forward the fork's `master` to `ruby/rdoc:master` before creating a new branch. Branching from a stale master invites merge conflicts and PRs that diverge from upstream history.
Loading