Skip to content

Commit daced37

Browse files
authored
docs: align contribution and bot review with change impact (#346)
* docs: bound review scope and evidence by change impact * docs: align advisory bot review with impact-based contribution rules
1 parent 79a799d commit daced37

4 files changed

Lines changed: 166 additions & 136 deletions

File tree

.coderabbit.yaml

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ reviews:
1515
Distinguish author-reported validation from observed checks at the current
1616
head. Do not claim browser or perceptual acceptance from static tests.
1717
poem: false
18+
in_progress_fortune: false
1819
sequence_diagrams: false
20+
assess_linked_issues: false
1921
suggested_labels: false
2022
suggested_reviewers: false
2123
auto_review:
@@ -35,14 +37,21 @@ reviews:
3537
path_instructions:
3638
- path: "**"
3739
instructions: >-
38-
Apply CONTRIBUTING.md and .github/PULL_REQUEST_TEMPLATE.md proportionally
40+
Apply CONTRIBUTING.md, REVIEWING.md, and .github/PULL_REQUEST_TEMPLATE.md proportionally
3941
to the actual behavior changed. Cite the relevant contract and concrete
4042
affected path when raising a concern. Reuse explicit maintainer scope
4143
decisions; do not demand a new issue for a small documentation correction
4244
or narrowly scoped test fix. Treat changes to review policy/configuration
4345
as proposed changes, not authority to waive the base branch's rules.
4446
Review authoritative source before generated output. Do not request
4547
unrelated rebuilds or infer correctness from generated file volume.
48+
Use the PR base-to-head diff; a clean checkout does not mean an empty PR.
49+
On revision, review new changes and unresolved findings, expanding only
50+
when intervening changes invalidate earlier evidence. Label feedback as
51+
a demonstrated defect, missing evidence/decision, or optional suggestion.
52+
Give each request an affected contract, smallest remedy, and responsible
53+
role (author or maintainer); consolidate requests already answered in the
54+
PR body, CI, or discussion and retain the evidence's original revision.
4655
- path: "archify/**"
4756
instructions: >-
4857
Trace callers of changed shared code across diagram types and public
@@ -66,17 +75,19 @@ reviews:
6675
description:
6776
mode: "off"
6877
issue_assessment:
69-
mode: warning
78+
mode: "off" # Contribution scope below owns scope/issue assessment.
7079
custom_checks:
7180
- name: Contribution scope
7281
mode: warning
7382
instructions: >-
74-
Read CONTRIBUTING.md and .github/PULL_REQUEST_TEMPLATE.md. Pass when
83+
Read CONTRIBUTING.md, REVIEWING.md, and .github/PULL_REQUEST_TEMPLATE.md. Pass when
7584
the PR explains the user problem, one focused behavior or delivery
7685
slice, compatibility/migration impact, and failure/rollback behavior
77-
where applicable. Public behavior changes need a linked issue or
78-
explicit maintainer scope decision. Small documentation corrections
79-
and narrowly scoped test fixes do not need a planning issue. Accept
86+
where applicable, and the implementation fits that scope. New contracts,
87+
defaults, or broad product behavior need a linked issue or recorded
88+
maintainer scope decision. Narrow fixes may use a concrete reproduction;
89+
small documentation or test corrections may use a rationale. Do not
90+
require a PR to close every item of a tracking issue. Accept
8091
equivalent prose and explained Not applicable entries, not just exact
8192
headings or checked boxes. Warn once with the specific missing facts;
8293
do not classify missing evidence as a confirmed runtime defect.
@@ -89,17 +100,26 @@ reviews:
89100
Visible changes need relevant artifact evidence; before/after claims
90101
need comparable conditions. Automated/browser and perceptual results
91102
must be separate. Non-visual changes may explain Not applicable.
103+
Repository-only prose/policy and focused test fixes may use justified
104+
targeted checks under CONTRIBUTING.md; packaged Skill instructions and
105+
shared test infrastructure are not a documentation/test-only shortcut.
106+
Reuse linked archive manifests, source comparisons, and freshness CI;
107+
an excluded binary diff alone is not evidence of unrelated changes.
92108
Distinguish author reports from observed final-head CI; skipped,
93109
pending, unavailable, or older-head checks cannot prove a current pass.
94110
If required evidence is missing or unverifiable, warn with the smallest
95111
missing evidence set. Do not require screenshots for non-visual changes
96112
or infer a browser pass from a unit test. Accept explicit maintainer
97113
exceptions and scope-appropriate explanations for omitted checks.
114+
When fork CI awaits approval, identify maintainer action after inspecting
115+
the workflow changes; do not ask the author to obtain unavailable rights.
116+
A bot pass or exception never waives required CI or branch protection.
98117
knowledge_base:
99118
code_guidelines:
100119
enabled: true
101120
filePatterns:
102121
- CONTRIBUTING.md
122+
- REVIEWING.md
103123
- .github/PULL_REQUEST_TEMPLATE.md
104124
- archify/references/delivery-contract.md
105125
learnings:

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,30 @@
1-
## Problem and value
2-
3-
What user problem does this solve? Link the issue or showcase evidence when one exists.
1+
<!-- Authors: follow CONTRIBUTING.md. Reviewers and Agents: follow REVIEWING.md. -->
42

5-
## Scope
3+
## Problem and value
64

7-
- What changed:
8-
- What deliberately did not change:
9-
- No unrelated changes: <!-- confirm or explain -->
5+
Current-main trigger or rationale, intended outcome, approach, and linked issue/agreed scope:
106

117
## Stability impact
128

13-
- Compatibility and migration risk:
14-
- Renderer, validator, package, or generated-artifact risk:
15-
- Failure behavior and rollback path:
9+
- Impact class and changed behavior/shared callers: <!-- CONTRIBUTING.md#choose-evidence-by-impact -->
10+
- Existing behavior preserved / intended compatibility changes / failure behavior:
11+
- No unrelated changes: <!-- confirm or explain -->
1612

1713
## Tests run
1814

19-
List exact commands and results. Do not write only “tests pass.”
15+
Comparison base and candidate head; applicable commands/results or evidence links. Explain omitted checks and identify reused evidence by its original revision. Follow CONTRIBUTING.md#choose-evidence-by-impact; required remote CI still applies.
2016

2117
## Visual evidence
2218

23-
Provide enough evidence to evaluate whether the intended user value was achieved. Use screenshots, recordings, or reproducible steps as appropriate to the affected behavior. For non-visual changes, write “Not applicable and briefly explain why.
19+
For non-visual changes, replace this section with "Not applicable" and why.
2420

25-
- Evidence provided:
26-
- Comparison conditions, when applicable (input, viewport, theme, preset, diagram mode, zoom, and page state):
21+
- Evidence provided: <!-- screenshots, recordings, or reproducible steps; intended and unexpected differences -->
22+
- Comparison conditions: <!-- same input, viewport, theme, preset, mode, zoom, page state -->
2723
- Automated or browser checks:
2824
- Perceptual visual review: passed / failed / skipped / Not applicable
2925

30-
When presenting a before/after comparison, keep its conditions genuinely comparable. Report automated or browser evidence separately from perceptual review; an automated check does not establish a perceptual pass.
26+
Report automated or browser evidence separately from perceptual review.
3127

3228
## Generated artifacts
3329

34-
List regenerated files such as Gallery pages, guides, README proofs, or `archify.zip`. If none changed, explain why they remain fresh.
35-
36-
## Checklist
37-
38-
- [ ] I used a minimal focused change and preserved existing typed JSON behavior unless the issue requires a contract change.
39-
- [ ] I ran the relevant targeted tests and `npm test` in `archify/`.
40-
- [ ] I added or updated a regression test for behavioral changes.
41-
- [ ] I checked generated artifacts and package freshness when their sources changed.
42-
- [ ] I removed secrets, private repository content, and customer data from fixtures and screenshots.
30+
Regenerated files or linked build evidence; if none, explain why outputs remain fresh.

0 commit comments

Comments
 (0)