Skip to content

docs(gh): add pr template for docs site#21

Open
zachyale wants to merge 1 commit into
mainfrom
docs/add-pr-template
Open

docs(gh): add pr template for docs site#21
zachyale wants to merge 1 commit into
mainfrom
docs/add-pr-template

Conversation

@zachyale
Copy link
Copy Markdown
Member

@zachyale zachyale commented May 5, 2026

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

  • Documentation
    • Added pull request template to standardize contribution guidelines and submission requirements for improved review consistency.

@zachyale zachyale enabled auto-merge (squash) May 5, 2026 01:37
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 5, 2026

📝 Walkthrough

Walkthrough

A GitHub pull request template is added at .github/pull_request_template.md. The template standardizes PR submissions with required sections for description, linked issues, and changes; optional sections for screenshots and context; and a checklist enforcing best practices including issue linking, focused scope, validation steps, and AI disclosure.

Changes

Pull Request Template Addition

Layer / File(s) Summary
Template Structure
.github/pull_request_template.md
Standard PR template with required sections (Description, Linked Issue, Changes, Manual Testing Steps, AI Disclosure), optional sections (Screenshots, Additional Context), and contributor checklist enforcing validation, scope focus, and AI usage disclosure.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

chore

Poem

📝 A template hops in, neat and bright,
With checkboxes dancing left and right—
No more wild PRs, all askew,
Now clarity guides what we do! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(gh): add pr template for docs site' follows the conventional commit format with proper scope (gh) and clear description of the change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-pr-template
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs/add-pr-template

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot added the chore label May 5, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.github/pull_request_template.md (1)

39-39: ⚡ Quick win

Clarify 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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d93a53 and d27fe7d.

📒 Files selected for processing (1)
  • .github/pull_request_template.md

@zachyale zachyale requested a review from imnotjames May 5, 2026 21:13
Comment thread .github/pull_request_template.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants