You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add acceptance criteria audit template for PRs (#538)
Replaces the basic 3-column acceptance criteria table with a comprehensive 5-column audit template in both the PR template and the contributor self-assessment guide. Adds explicit instructions for handling and documenting partially completed work.
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,13 +46,13 @@ requesting review. Include concise evidence below; use
46
46
47
47
<!-- Write "None known" only after checking for limitations. -->
48
48
49
-
### Acceptance Criteria
49
+
### Acceptance Criteria Audit
50
50
51
-
<!-- Map your changes to the issue acceptance criteria. See the [Traceability Table Guide](../docs/traceability-table.md) for how to fill this out. -->
51
+
<!-- Map your changes to the issue acceptance criteria. See the [Traceability Table Guide](../docs/traceability-table.md) and docs/contributor-self-assessment.md for guidance on handling incomplete criteria and filling each field. -->
52
52
53
-
| Acceptance criterion| Implementation or evidence| Status |
54
-
| --- | --- | --- |
55
-
|<!-- Criterion -->|<!-- File, test, screenshot, or explanation -->|Pass / Not applicable|
53
+
| Acceptance Criterion| Implementation Evidence | Test Evidence | Documentation Impact| Status |
54
+
| --- | --- | --- | --- | --- |
55
+
|<!-- Criterion -->|<!-- File, screenshot, or explanation -->|<!-- Test file or manual check -->|<!-- Docs changed, or N/A -->| Complete / Partial / Not Applicable / Not Implemented|
Copy file name to clipboardExpand all lines: docs/contributor-self-assessment.md
+21-5Lines changed: 21 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,20 +81,36 @@ describe its user impact and link a follow-up issue when one exists.
81
81
82
82
**Known limitations and follow-up work:**
83
83
84
-
### Acceptance Criteria
84
+
### Acceptance Criteria Audit
85
85
86
86
-[ ] I checked every acceptance criterion in the linked issue against the
87
87
implementation and evidence.
88
88
-[ ] Every criterion is satisfied, or an exception has been explicitly agreed
89
89
with a maintainer and documented below.
90
90
91
-
<!-- Map each acceptance criterion to implementation or verification evidence. -->
91
+
#### How to Complete the Audit Template
92
+
93
+
-**Acceptance Criterion:** Copy the exact requirement from the issue.
94
+
-**Implementation Evidence:** List the files modified, attach a screenshot, or explain the change.
95
+
-**Test Evidence:** Reference the automated test file, or describe the manual verification step.
96
+
-**Documentation Impact:** List any updated documentation files, or write "None needed" if applicable.
97
+
-**Status:** Must be exactly one of: `Complete`, `Partial`, `Not Applicable`, `Not Implemented`.
98
+
99
+
#### Handling Incomplete Criteria
100
+
101
+
When a piece of work cannot be fully completed in the current pull request:
102
+
- Explain why a criterion is incomplete in the *Implementation Evidence* column.
103
+
- Link to follow-up issues if applicable.
104
+
- Clearly distinguish completed work from future work.
105
+
- Avoid marking incomplete work as complete (use `Partial` or `Not Implemented`).
106
+
107
+
<!-- Map each acceptance criterion to implementation or verification evidence using the audit template below. -->
92
108
93
109
**Acceptance criteria confirmation:**
94
110
95
-
| Acceptance criterion| Implementation or evidence| Status |
96
-
| --- | --- | --- |
97
-
|<!-- Criterion -->|<!-- File, test, screenshot, or explanation -->|Pass / Not applicable|
111
+
| Acceptance Criterion| Implementation Evidence | Test Evidence | Documentation Impact| Status |
112
+
| --- | --- | --- | --- | --- |
113
+
|<!-- Criterion -->|<!-- File, screenshot, or explanation -->|<!-- Test file or manual check -->|<!-- Docs changed, or N/A -->| Complete / Partial / Not Applicable / Not Implemented|
0 commit comments