Commit 3df5265
authored
* Add review history markers to Review System Infrastructure files
PERMANENT BOILERPLATE - these review history sections document when
files were created/reviewed and will remain in files permanently.
Files marked for Review #10 (Review System Infrastructure):
- .github/ISSUE_TEMPLATE/architectural-review.yml
- .github/PULL_REQUEST_TEMPLATE/architectural-review.md
- .github/workflows/architectural-review-validation.yml
- docs/developer/GITHUB-REVIEW-INTEGRATION.md
- docs/developer/REVIEW-WORKFLOW-QUICK-START.md
- docs/reviews/2025-11/REVIEW-SYSTEM-INFRASTRUCTURE-REVIEW.md
These markers will NOT be removed when PR closes - they serve as
permanent documentation of review history.
* Address reviewer feedback: Add navigation and workflow sections
Added two critical sections requested by @lmoresi in PR #35:
1. **How to Review This Document** (top of document):
- Quick orientation for reviewers
- How to navigate the 6 files in PR
- What to look for
- Time estimate
2. **Reviewer Workflow** (before Known Limitations):
- How to provide feedback (3 options)
- How to change review status labels
- How to approve the review (UI + CLI)
- Status transition diagram
- What happens after approval
- Where to ask questions
These sections make the review self-contained and actionable.
Addresses issue #33 feedback about unclear workflow.
* Add code change review requirements and fix branch links
Addresses @lmoresi feedback from PR #35:
1. **Fixed branch links** (Issue: links pointed to base branch, not review files):
- Added direct link to review branch
- Added link to files in review
- Added note about using PR 'Files changed' tab
2. **Added Code Change Review Requirements** section:
- Purpose of change (required format)
- Breaking changes & API changes (dedicated section)
- Rationale for changes (alternatives considered)
- Deprecation plan (if breaking changes exist)
- Migration strategy (timeline, steps, resources)
- Complete example review showing all 5 requirements
This ensures code reviews have comprehensive documentation of:
- What changed and why
- Impact on users
- How to migrate
- Support timeline
Addresses the 'only so much one can do reviewing a review' by
establishing clear requirements for future code reviews.
1 parent 61ff9cf commit 3df5265
File tree
6 files changed
+398
-0
lines changed- .github
- ISSUE_TEMPLATE
- PULL_REQUEST_TEMPLATE
- workflows
- docs
- developer
- reviews/2025-11
6 files changed
+398
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
129 | 129 | | |
130 | 130 | | |
131 | 131 | | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
174 | 174 | | |
175 | 175 | | |
176 | 176 | | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
527 | 527 | | |
528 | 528 | | |
529 | 529 | | |
| 530 | + | |
| 531 | + | |
| 532 | + | |
| 533 | + | |
| 534 | + | |
| 535 | + | |
| 536 | + | |
| 537 | + | |
| 538 | + | |
| 539 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
364 | 364 | | |
365 | 365 | | |
366 | 366 | | |
| 367 | + | |
| 368 | + | |
| 369 | + | |
| 370 | + | |
| 371 | + | |
| 372 | + | |
| 373 | + | |
| 374 | + | |
| 375 | + | |
| 376 | + | |
0 commit comments