Skip to content

chore: add pr template#449

Merged
ericksoa merged 3 commits intomainfrom
add-pr-template
Mar 19, 2026
Merged

chore: add pr template#449
ericksoa merged 3 commits intomainfrom
add-pr-template

Conversation

@miyoungc
Copy link
Copy Markdown
Contributor

@miyoungc miyoungc commented Mar 19, 2026

Summary by CodeRabbit

  • Chores
    • Added a standardized pull request template to streamline submissions with sections for Summary, Related Issue, Changes, Type of Change, and Testing.
    • Includes a contributor checklist with conditional subsections for code vs. doc changes, task checkboxes for formatting/tests/secrets, guidance on style and license headers, and inline instructional comments for authors.

@miyoungc miyoungc added the project management Use this label for meta-issues about project governance and community processes. label Mar 19, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 19, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bc7464d4-f08d-4950-b2f4-11d24831a693

📥 Commits

Reviewing files that changed from the base of the PR and between 0ca27c1 and 0158f19.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md
✅ Files skipped from review due to trivial changes (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

Adds a GitHub pull request template file that structures PR submissions into Summary, Related Issue, Changes, Type of Change, Testing, and nested contributor checklists with HTML guidance comments and checklist items for code and documentation.

Changes

Cohort / File(s) Summary
Pull Request Template
.github/PULL_REQUEST_TEMPLATE.md
Added a new PR template with sections: Summary, Related Issue, Changes, Type of Change, Testing, and a Checklist (code and docs) including formatting/tests/secrets checks, SPDX/frontmatter guidance, and HTML comments instructing authors.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I hopped through the repo to lay out the form,
Lines and checkboxes tidy and warm.
Reminders for tests, headers, and links,
A carrot of order—now reviewers can blink. 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'chore: add pr template' directly and clearly describes the main change: adding a pull request template file to the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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 add-pr-template
📝 Coding Plan
  • Generate coding plan for human review comments

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

Copy link
Copy Markdown
Contributor

@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)

33-33: Break the checklist item into separate lines for better readability.

Line 33 combines the style guide reference and the update-docs agent skill instruction in a single long line. While both references are accurate, splitting them improves clarity for contributors reviewing the template.

♻️ Suggested refactor
 ### Doc changes
 <!-- Skip if this PR has no doc changes. -->
-- [ ] Follows the [style guide](docs/CONTRIBUTING.md). Try running the `update-docs` agent skill to draft changes while complying with the style guide. For example, prompt your agent with "`/update-docs` catch up the docs for the new changes I made in this PR."
+- [ ] Follows the [style guide](docs/CONTRIBUTING.md)
+- [ ] Consider using the `update-docs` agent skill to draft changes (e.g., "`/update-docs` catch up the docs for the new changes I made in this PR")
 - [ ] New pages include SPDX license header and frontmatter
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/PULL_REQUEST_TEMPLATE.md at line 33, Split the single long checklist
item into two separate items: one checkbox reading "Follows the [style
guide](docs/CONTRIBUTING.md)." and a second checkbox with the agent instruction
"Try running the `update-docs` agent skill to draft changes while complying with
the style guide (e.g. prompt your agent with `/update-docs` to catch up the docs
for the changes in this PR)." Update the checklist in
.github/PULL_REQUEST_TEMPLATE.md to replace the combined line with these two
distinct lines so each guidance is clear and independently checkable.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/PULL_REQUEST_TEMPLATE.md:
- Line 33: Split the single long checklist item into two separate items: one
checkbox reading "Follows the [style guide](docs/CONTRIBUTING.md)." and a second
checkbox with the agent instruction "Try running the `update-docs` agent skill
to draft changes while complying with the style guide (e.g. prompt your agent
with `/update-docs` to catch up the docs for the changes in this PR)." Update
the checklist in .github/PULL_REQUEST_TEMPLATE.md to replace the combined line
with these two distinct lines so each guidance is clear and independently
checkable.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: cda40895-3000-4d23-9cf8-555f3640099e

📥 Commits

Reviewing files that changed from the base of the PR and between 16fb337 and e192bbd.

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

Copy link
Copy Markdown
Contributor

@ericksoa ericksoa left a comment

Choose a reason for hiding this comment

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

Clean PR template. LGTM.

@ericksoa ericksoa merged commit be92f71 into main Mar 19, 2026
3 checks passed
Ryuketsukami pushed a commit to Ryuketsukami/NemoClaw that referenced this pull request Mar 24, 2026
* add pr template

* rm redundant item

* improve
jessesanford pushed a commit to jessesanford/NemoClaw that referenced this pull request Mar 24, 2026
* add pr template

* rm redundant item

* improve
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

project management Use this label for meta-issues about project governance and community processes.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants