-
Notifications
You must be signed in to change notification settings - Fork 881
ci: Add pull request reviewer via gitar #7649
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
c-warren
wants to merge
4
commits into
cadence-workflow:master
Choose a base branch
from
c-warren:cwarren/gitar_config
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+78
−0
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| --- | ||
| title: PR Description Quality Standards | ||
| description: Ensures PR descriptions meet Cadence quality criteria using guidance from PR template | ||
| when: PR description is created or updated | ||
| actions: Read PR template for guidance then report requirement status | ||
| --- | ||
|
|
||
| # PR Description Quality Standards | ||
|
|
||
| When evaluating a pull request description: | ||
|
|
||
| 1. **Read the PR template** at `.github/pull_request_template.md` to understand the expected guidance for each section | ||
| 2. Apply that guidance to evaluate the current PR description | ||
| 3. Provide recommendations for how to improve the description. | ||
|
|
||
| ## Core Principle: Why Not How | ||
|
|
||
| From https://cbea.ms/git-commit/#why-not-how: | ||
| - **"A diff shows WHAT changed, but only the description can explain WHY"** | ||
| - Focus on: the problem being solved, the reasoning behind the solution, context | ||
| - The code itself documents HOW - the PR description documents WHY | ||
|
|
||
| ## Evaluation Criteria | ||
|
|
||
| ### Required Sections (must exist with substantive content per PR template guidance) | ||
|
|
||
| 1. **What changed?** | ||
| - 1-2 line summary of WHAT changed technically | ||
| - Focus on key modification, not implementation details | ||
| - Template has good/bad examples | ||
|
|
||
| 2. **Why?** | ||
| - Full context and motivation | ||
| - What problem does this solve? What's the use case? | ||
| - What's the impact if we don't make this change? | ||
| - **CRITICAL**: Technical rationale required for ALL changes (not just large ones) | ||
| - Must explain WHY this implementation approach was chosen | ||
|
|
||
| 3. **How did you test it?** | ||
| - Concrete, copyable commands with exact invocations | ||
| - ✅ GOOD: `go test -v ./common/types/mapper/proto -run TestFailoverDomainRequest` | ||
| - ❌ BAD: "Tested locally" or "See tests/foo_test.go" | ||
| - For integration tests: setup steps + commands | ||
| - For canary: which canary, environment, results | ||
|
|
||
| 4. **Potential risks** | ||
| - Backward/forward compatibility concerns? | ||
| - Performance impact? What could break? Safe to rollback? | ||
|
|
||
| 5. **Release notes** | ||
| - If this completes a user-facing feature, describe it | ||
| - Skip for: incremental work, internal refactors, partial implementations | ||
|
|
||
| 6. **Documentation Changes** | ||
| - Config changes affecting operation-guide? | ||
| - New features needing user docs? | ||
| - Only mark N/A if certain no docs affected | ||
|
|
||
| ### Quality Checks | ||
|
|
||
| - **Skip obvious things** - Don't flag items clear from folder structure | ||
| - **Skip trivial refactors** - Minor formatting/style changes don't need deep rationale | ||
| - **Don't check automated items** - Issue links, CI, linting are automated | ||
|
|
||
| ## FORBIDDEN - Never Include | ||
|
|
||
| - ❌ "Issues Found", "Testing Evidence Quality", "Documentation Reasoning", "Summary" sections | ||
| - ❌ "Note:" paragraphs or explanatory text outside recommendations | ||
| - ❌ Grouping recommendations by type | ||
|
|
||
| ## Section Names (Use EXACT Brackets) | ||
|
|
||
| - **[What changed?]** | ||
| - **[Why?]** | ||
| - **[How did you test it?]** | ||
| - **[Potential risks]** | ||
| - **[Release notes]** | ||
| - **[Documentation Changes]** | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if a whole new test file is created or a large number of tests are created? I think providing the file can be sufficient depending on the case