Skip to content

DOC: add PR impact rating and guidelines for AI-assisted pull requests - #62

Merged
raphaelvallat merged 2 commits into
masterfrom
pr-guidelines
Oct 24, 2026
Merged

raphaelvallat merged 2 commits into
masterfrom
pr-guidelines

Conversation

@raphaelvallat

Copy link
Copy Markdown
Owner

Summary

Adds guidelines to reduce the review burden of low-value pull requests. Every PR must now state its user impact on a P1-P4 scale and justify it; P4 changes (refactors without behavior change, type hints or docstring wording only, test-only changes, unbenchmarked micro-optimizations, edge cases nobody hits) are not accepted as standalone PRs. Also adds guidelines for AI-assisted PRs, modeled on YASA's, and a PR template that asks for the impact rating, the AI model used, and a checklist.

Changes:

  • docs/contributing.rst: new sections "Assessing the impact of your change" and "Guidelines for AI-assisted pull requests".
  • .github/pull_request_template.md: new.

Impact

Rating: P2

Why: Process documentation that affects every future contributor and frees maintainer time for changes that matter to users.

AI assistance

Model used: Claude Fable 5.1 via Claude Code

Checklist

  • The impact rating is stated and justified above (P1-P3)
  • The branch is up to date with master, and I checked open PRs for conflicts
  • The PR is small and focused
  • The description starts with my own summary
  • No tests needed (docs only)
  • The documentation is updated (RST validated with docutils in strict mode)
  • The changelog was not modified

🤖 Generated with Claude Code

raphaelvallat and others added 2 commits October 24, 2026 13:47
Add two sections to the contributing guide: a P1-P4 user-impact scale that
every PR must state (P4 changes are not accepted as standalone PRs), and
guidelines for AI-assisted PRs modeled on YASA's. Add a PR template that
asks for the impact rating, the AI model used, and the review checklist.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@raphaelvallat
raphaelvallat merged commit 93f6814 into master Oct 24, 2026
3 checks passed
@raphaelvallat
raphaelvallat deleted the pr-guidelines branch October 24, 2026 11:50
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.

1 participant