review checklist

[nerdCopter]

• open to additions, modifications, opinions.
• purpose is for a checklist for PR approval before merge.

adds to the pull_request_template.md:

**Checklist** (✓/✕, or y/n)
- [ ] passed schematics review
- [ ] passed hardware samples testing
- [ ] follows guidelines
- [ ] follows connector standards
- [ ] comments/issues resolved

Summary by CodeRabbit

• Documentation
  • Updated the pull request template to include a checklist for contributors, helping ensure all required verifications are completed before submission.

[coderabbitai]

Walkthrough

The pull request updates the pull request template by appending a new checklist section at the end. This checklist outlines several verification items for contributors to confirm before submitting a pull request, using markdown checkboxes for each item. No other changes or removals were made to the template.

Changes

File	Change Summary
.github/pull_request_template.md	Added a checklist section with markdown checkboxes for contributors to verify before submission.

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

---

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary or `` to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[nerdCopter]

I noticed in this comment that checkmarks are easy to click and change, so my concern is any that public or unauthorized user could modify. thoughts/corrections?

edit: seems the text can be modified directly to [x] to produce checks, and also user can just click. so maybe the (✓/✕, or y/n) should not be included.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

.github/pull_request_template.md (1)

23-29: Enhance checklist clarity and enforce gating
The new markdown checkboxes provide a nice visual reminder, but they can be manually toggled by any user with edit access to the PR description. Consider:

• Updating the header to explicitly state “All boxes must be checked before merge” or similar.
• Automating enforcement using a GitHub Action that scans PR bodies and fails the check run if any items remain unchecked.
• Optionally capturing more detail per item (e.g., links to schematics review sign-off or hardware test logs) to improve traceability.

This will turn the checklist from a passive guideline into an actionable, enforceable requirement.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 17892ac and 12f408f.

📒 Files selected for processing (1)

• .github/pull_request_template.md (1 hunks)

[sugaarK]

nice stuff