chore: add CODEOWNERS and a PR template for the review process - #646
Open
hongquanli wants to merge 1 commit into
Open
hongquanli wants to merge 1 commit into
hongquanli wants to merge 1 commit into
Conversation
CODEOWNERS routes every PR to the maintainer of master (@Alpaca233) and firmware plus the host<->MCU driver to @hongquanli, so GitHub requests the right reviewer automatically. The PR template carries the ready-for-review checklist: what, why, the flag or config that gates the change, CI and hardware evidence, size and stacking. Design and rationale: AI-docs Squid/to-do/2026-09-09-pr-backlog-and-customer-lanes-design.md Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_0135ZEPVUoAwjCfCQCjpPcnU
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The current CODEOWNERS patterns override the default * entry for firmware/protocol paths, so they won’t request both reviewers as intended.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR adds GitHub metadata files to standardize the review process by automatically requesting reviewers via CODEOWNERS and by providing a structured pull request template to ensure consistent “ready for review” criteria across contributors.
Changes:
- Add
.github/CODEOWNERSto route reviews by path (default maintainer + firmware/protocol owner). - Add
.github/pull_request_template.mdwith a ready-for-review checklist and evidence/size expectations.
File summaries
| File | Description |
|---|---|
.github/CODEOWNERS |
Introduces path-based review ownership rules for automatic reviewer requests. |
.github/pull_request_template.md |
Adds a PR template checklist to standardize review readiness and evidence expectations. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+3
to
+8
| * @Alpaca233 | ||
|
|
||
| # Firmware and the host <-> MCU protocol: Hongquan reviews. | ||
| /firmware/ @hongquanli | ||
| /software/control/microcontroller.py @hongquanli | ||
| /software/control/firmware_sim_serial.py @hongquanli |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
.github/CODEOWNERS: every PR requests a review from @Alpaca233 (maintainer of master);firmware/,control/microcontroller.pyandcontrol/firmware_sim_serial.pyrequest @hongquanli..github/pull_request_template.md: the ready-for-review checklist (what, why, the flag or config that gates the change, CI and hardware evidence, size and stacking).Why
61 PRs were open on 2026-09-08 and 44 of them had never been reviewed, because nobody was assigned. CODEOWNERS makes GitHub do the assignment. The template makes "ready for review" mean the same thing for everyone.
Process design with the merge order for the open backlog: AI-docs
Squid/to-do/2026-09-09-pr-backlog-and-customer-lanes-design.md(approved 2026-09-08).Test plan
firmware/and confirm both reviewers are requested.🤖 Generated with Claude Code
https://claude.ai/code/session_0135ZEPVUoAwjCfCQCjpPcnU