docs: add PR template#45
Conversation
|
Warning Rate limit exceeded
To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Review rate limit: 0/1 reviews remaining, refill in 35 minutes and 31 seconds.Comment |
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new pull request template in .github/PULL_REQUEST_TEMPLATE.md to standardize contributions. The review feedback suggests several improvements to align the template with existing project guidelines in CONTRIBUTING.md, including prompting for the rationale behind changes, expanding the testing checklist to cover builds and formatting, and adding specific placeholders for AgilePlus specs and ADRs.
| @@ -0,0 +1,20 @@ | |||
| ## Summary | |||
|
|
|||
| <!-- What does this PR do, in 1-3 sentences --> | |||
There was a problem hiding this comment.
The CONTRIBUTING.md (line 55) requires describing both what changed and why. Updating the prompt in the Summary section will help ensure contributors provide the necessary context.
| <!-- What does this PR do, in 1-3 sentences --> | |
| <!-- What does this PR do and why, in 1-3 sentences --> |
| - [ ] Local lint passes | ||
| - [ ] Local tests pass | ||
| - [ ] Manual smoke test (if applicable) |
There was a problem hiding this comment.
To align with the quality gates and local development steps defined in CONTRIBUTING.md (lines 54, 61, 108), the testing checklist should include build, formatting, and lint suppression checks.
| - [ ] Local lint passes | |
| - [ ] Local tests pass | |
| - [ ] Manual smoke test (if applicable) | |
| - [ ] Local build passes | |
| - [ ] Local lint/format passes | |
| - [ ] Local tests pass | |
| - [ ] No new lint suppressions (or justified) | |
| - [ ] Manual smoke test (if applicable) |
| <!-- Issues/PRs/specs this addresses --> | ||
| Closes # |
There was a problem hiding this comment.
According to the CONTRIBUTING.md (lines 7-11, 55), linking an AgilePlus spec is a mandate for non-trivial work. Providing a specific placeholder for the spec and ADRs improves traceability.
| <!-- Issues/PRs/specs this addresses --> | |
| Closes # | |
| <!-- Issues/PRs/specs/ADRs this addresses. AgilePlus specs are mandated for non-trivial work. --> | |
| - AgilePlus Spec: | |
| - Closes # |
1 participant
Bootstraps standard PR template.
Note
Low Risk
Adds a GitHub PR template only; no runtime code paths, logic, or dependencies are affected.
Overview
Introduces a standardized
.github/PULL_REQUEST_TEMPLATE.mdto guide contributors on providing a summary, key changes, testing checklist, and related issue links for each PR.Reviewed by Cursor Bugbot for commit 9c173ae. Bugbot is set up for automated code reviews on this repo. Configure here.