From 49abb88465639dbf6f2c617d23a83b484333b36c Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 7 May 2026 03:49:07 +0000 Subject: [PATCH 1/2] Document PR description style for AI-assisted contributions Add a rule under the 'Notes for AI Agents' section requiring concise PR descriptions (2-4 short paragraphs covering context, rationale, and notable side effects), with no 'Test plan' section and no Claude Code session link or other AI attribution. This overrides the default Claude Code PR template so cloud sessions working on this repo produce uniform descriptions. --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index 53e9701699..a699916990 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -405,3 +405,4 @@ 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. From 134497b5ac83c535bbe454c66d127c576db95136 Mon Sep 17 00:00:00 2001 From: Claude Date: Thu, 7 May 2026 04:44:11 +0000 Subject: [PATCH 2/2] AGENTS.md: require fork master to be synced with ruby/rdoc before branching --- AGENTS.md | 1 + 1 file changed, 1 insertion(+) diff --git a/AGENTS.md b/AGENTS.md index a699916990..d3d5e8be24 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -406,3 +406,4 @@ For server-specific E2E testing (endpoint checks, live-reload verification, file 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.