Repository navigation
DOC: add PR impact rating and guidelines for AI-assisted pull requests - #62
Merged
Merged
Conversation
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>
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
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
master, and I checked open PRs for conflicts🤖 Generated with Claude Code