docs: point the PR-description rules at the template instead of copying it - #250
Merged
Conversation
…ng it AGENTS.md reproduced `.github/pull_request_template.md` inline, and the copy had drifted: every heading differed from the real one, and the documented `Type` list had no `Refactor` or `CI / tooling`. Since the checkbox is meant to mirror the commit type, a refactor PR following this file had to pick `Others`. Reference the file rather than restating it -- a copy is what drifts -- and keep only the rules the template itself does not carry. The filling rules now name the template's actual sections, and say what each one is for: `Verification` wants the commands and their result rather than a claim that they ran, `Related Issues` distinguishes `Fixes #NNN` from a bare reference, and `Type` is a mirror of the commit type rather than a fresh judgement call. Co-authored-by: Claude (claude-opus-5[1m]) <noreply@anthropic.com>
gloryfromca
approved these changes
Jul 30, 2026
arelchan
approved these changes
Jul 30, 2026
0xKT
added a commit
that referenced
this pull request
Jul 31, 2026
## Summary Bump the package version from 0.1.9 to 0.1.10 (patch release). 22 PRs merged since v0.1.9, no breaking changes. Features: - #260 feat(tui): list the providers that work, and the rest one level down - #252 feat(*): offer every supported provider in the onboarding picker - #251 feat(tools): read images with read_file, and fix four silent type-check bugs - #239 feat: add shell command approval flow - #217 feat: rework the TUI transcript into collapsible episodes - #220 feat(cli): nudge raven upgrade in the tui status bar when behind - #209 feat(providers): add MiniMax Global and CN OAuth Refactors: - #259 refactor(*): one answer to which credentials a provider needs - #249 refactor(providers): unify provider management on litellm The remaining PRs are fixes (#255, #256, #258, #253, #238, #226), test work (#236, #230, #224), docs (#250, #215, #200), and benchmark tooling (#207). ## Type - [ ] Fix - [ ] Feature - [ ] Docs - [ ] CI / tooling - [ ] Refactor - [x] Other ## Verification - [x] Relevant tests pass locally - [x] Relevant lint / type checks pass locally - [ ] User-facing docs or screenshots are updated when needed Bump is limited to `pyproject.toml` and `uv.lock` (`uv lock` sync). Local preflight covers the branch CI checks (commit lint, PR title and body lint, ruff, large-file gate). ## Risk - [x] Security impact considered - [x] Backward compatibility considered - [x] Rollback path is clear for risky changes Version-only change; no code or behavior change. Rollback is a revert of this commit. ## Related Issues N/A Co-authored-by: Claude (claude-opus-5[1m]) <noreply@anthropic.com>
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
AGENTS.md section 3.7 reproduced
.github/pull_request_template.mdinline, andthe copy had drifted from it. Every heading differed, and the documented
Typelist had no
RefactororCI / tooling-- so a refactor PR following this filehad to pick
Others, while the real template offers the right box. The samesection tells you the checkbox mirrors the commit type, which a list missing two
commit types cannot do.
Reference the file rather than restating it: a copy is what drifts. The filling
rules now name the template's actual sections and say what each is for --
Verificationwants the commands and their result rather than a claim that theyran,
Related IssuesdistinguishesFixes #NNNfrom a bare reference, andTypeis a mirror of the commit type rather than a fresh judgement call.Net effect is 37 lines removed and 7 added: the rules that are not in the
template stay, the duplicate of the template goes.
Type
Verification
CLAUDE.mdis a symlink toAGENTS.md, so both read the corrected text.Risk
Documentation only; no code path changes. The advice it replaces was already
unusable as written, so following the new text cannot produce a worse PR than
following the old one. Rollback is a revert.
Related Issues
Fixes #241