Skip to content

docs: point the PR-description rules at the template instead of copying it - #250

Merged
0xKT merged 1 commit into
mainfrom
docs/fix_pr_template_reference
Jul 30, 2026
Merged

docs: point the PR-description rules at the template instead of copying it#250
0xKT merged 1 commit into
mainfrom
docs/fix_pr_template_reference

Conversation

@0xKT

@0xKT 0xKT commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

Summary

AGENTS.md section 3.7 reproduced .github/pull_request_template.md inline, and
the copy had drifted from it. Every heading differed, and the documented Type
list had no Refactor or CI / tooling -- so a refactor PR following this file
had to pick Others, while the real template offers the right box. The same
section 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 --
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.

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

  • Fix
  • Feature
  • Docs
  • CI / tooling
  • Refactor
  • Other

Verification

uv run pre-commit run --files AGENTS.md      # passed
make check-large-files                        # passed
npx commitlint --from origin/main --to HEAD --config commitlint.config.cjs
grep -rn "Change description|Type of change|Checklists" AGENTS.md   # no matches left

CLAUDE.md is a symlink to AGENTS.md, so both read the corrected text.

  • Relevant tests pass locally
  • Relevant lint / type checks pass locally
  • User-facing docs or screenshots are updated when needed

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.

  • Security impact considered
  • Backward compatibility considered
  • Rollback path is clear for risky changes

Related Issues

Fixes #241

…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>
@0xKT
0xKT requested a review from gloryfromca July 30, 2026 13:49
@0xKT
0xKT requested a review from arelchan July 30, 2026 13:54
@0xKT
0xKT merged commit 01b7c4c into main Jul 30, 2026
9 checks passed
@0xKT
0xKT deleted the docs/fix_pr_template_reference branch July 30, 2026 14:04
@0xKT 0xKT mentioned this pull request Jul 31, 2026
12 tasks
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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: AGENTS.md reproduces a PR template that has drifted from the real one

3 participants