docs(gh): add pr template for docs site#21
Conversation
📝 WalkthroughWalkthroughA GitHub pull request template is added at ChangesPull Request Template Addition
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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. Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
.github/pull_request_template.md (1)
39-39: ⚡ Quick winClarify the AI policy reference to avoid ambiguity.
“AI Policy above” is unclear because the template only has an AI Disclosure section, not policy text. Consider changing this to “as per the organization AI policy” (or include a policy link) so contributors know exactly what to follow.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In @.github/pull_request_template.md at line 39, Update the checklist item text that currently reads "[ ] I have disclosed any AI usage as per the organization AI Policy above." to remove the ambiguous "above" reference—change it to a clear phrase such as "[ ] I have disclosed any AI usage as per the organization AI policy" or include a direct link to the policy; edit the checklist string in .github/pull_request_template.md (the AI disclosure checkbox line) to use the new wording or add a hyperlink so contributors know the exact policy to follow.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In @.github/pull_request_template.md:
- Line 39: Update the checklist item text that currently reads "[ ] I have
disclosed any AI usage as per the organization AI Policy above." to remove the
ambiguous "above" reference—change it to a clear phrase such as "[ ] I have
disclosed any AI usage as per the organization AI policy" or include a direct
link to the policy; edit the checklist string in
.github/pull_request_template.md (the AI disclosure checkbox line) to use the
new wording or add a hyperlink so contributors know the exact policy to follow.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 033f4315-6a6d-40a2-8b47-f14dbf443d43
📒 Files selected for processing (1)
.github/pull_request_template.md
added a template that closely follows the grimmory specific repo template.
the irony is this PR for the template does not follow the template. however it will be the last one to do so :)
Summary by CodeRabbit