docs: add PR self-review norms and code flow section#111
docs: add PR self-review norms and code flow section#111ian-flores wants to merge 1 commit intomainfrom
Conversation
|
Claude finished @ian-flores's task —— View job PR Review: docs: add PR self-review norms and code flow sectionOverall this is a solid set of team norms for balancing effort between author and reviewer. Feedback below is mostly about reducing friction and avoiding redundancy with existing conventions.
|
| @@ -0,0 +1,34 @@ | |||
| # Description | |||
There was a problem hiding this comment.
Team-operator didn't have a PR template before — this is new. It includes a reminder about the conventional commit format for PR titles since that's enforced by CI and drives semantic versioning.
| ## Checklist | ||
|
|
||
| - [ ] I have run `just test` and all tests pass | ||
| - [ ] I have reviewed my own diff and added inline comments on lines I want reviewers to focus on or that I am uncertain about |
There was a problem hiding this comment.
Same self-review checklist item as ptd and ptd-config. Also added just test since that's the standard pre-merge check for this repo.
| @@ -1,5 +1,13 @@ | |||
| # Team Operator Code Review Guidelines | |||
|
|
|||
| ## Reviewer Responsibilities | |||
There was a problem hiding this comment.
New section. Same reviewer responsibilities framing as the other PTD repos — review the code itself, not just the description.
| @@ -14,6 +22,12 @@ | |||
| - Dependencies should be minimal and justified | |||
There was a problem hiding this comment.
Added code quality fundamentals (encapsulation, DRY, naming, complexity). The existing review-guidelines.md had simplicity and maintainability principles but not these explicit quality checks.
Summary
.github/pull_request_template.mdwith Description, Code Flow, Category of change, and Checklist sections.claude/review-guidelines.mdwith reviewer responsibilities, code quality fundamentals (encapsulation, DRY, naming, complexity), and the self-review normThese changes reflect new team norms for balancing PR effort between author and reviewer in an agentic coding workflow.
Test plan
.claude/review-guidelines.mdis accessible to Claude Code sessions