Skip to content

Commit 20c2fd2

Browse files
authored
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.
1 parent cc798fe commit 20c2fd2

2 files changed

Lines changed: 26 additions & 10 deletions

File tree

.github/pull_request_template.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ requesting review. Include concise evidence below; use
4646

4747
<!-- Write "None known" only after checking for limitations. -->
4848

49-
### Acceptance Criteria
49+
### Acceptance Criteria Audit
5050

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. -->
5252

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 |
5656

5757
## Screenshots or Recordings
5858

docs/contributor-self-assessment.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,36 @@ describe its user impact and link a follow-up issue when one exists.
8181

8282
**Known limitations and follow-up work:**
8383

84-
### Acceptance Criteria
84+
### Acceptance Criteria Audit
8585

8686
- [ ] I checked every acceptance criterion in the linked issue against the
8787
implementation and evidence.
8888
- [ ] Every criterion is satisfied, or an exception has been explicitly agreed
8989
with a maintainer and documented below.
9090

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. -->
92108

93109
**Acceptance criteria confirmation:**
94110

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 |
98114

99115
### Final Confirmation
100116

0 commit comments

Comments
 (0)