Skip to content

docs: add acceptance criteria audit template for PRs #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
El-swaggerito merged 1 commit into from
Jul 29, 2026
Merged

docs: add acceptance criteria audit template for PRs #538

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ requesting review. Include concise evidence below; use

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

### Acceptance Criteria
### Acceptance Criteria Audit

<!-- Map your changes to the issue acceptance criteria. See the [Traceability Table Guide](../docs/traceability-table.md) for how to fill this out. -->
<!-- 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. -->

| Acceptance criterion | Implementation or evidence | Status |
| --- | --- | --- |
| <!-- Criterion --> | <!-- File, test, screenshot, or explanation --> | Pass / Not applicable |
| Acceptance Criterion | Implementation Evidence | Test Evidence | Documentation Impact | Status |
| --- | --- | --- | --- | --- |
| <!-- Criterion --> | <!-- File, screenshot, or explanation --> | <!-- Test file or manual check --> | <!-- Docs changed, or N/A --> | Complete / Partial / Not Applicable / Not Implemented |

## Screenshots or Recordings

Expand Down
26 changes: 21 additions & 5 deletions docs/contributor-self-assessment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,20 +81,36 @@ describe its user impact and link a follow-up issue when one exists.

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

### Acceptance Criteria
### Acceptance Criteria Audit

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

<!-- Map each acceptance criterion to implementation or verification evidence. -->
#### How to Complete the Audit Template

- **Acceptance Criterion:** Copy the exact requirement from the issue.
- **Implementation Evidence:** List the files modified, attach a screenshot, or explain the change.
- **Test Evidence:** Reference the automated test file, or describe the manual verification step.
- **Documentation Impact:** List any updated documentation files, or write "None needed" if applicable.
- **Status:** Must be exactly one of: `Complete`, `Partial`, `Not Applicable`, `Not Implemented`.

#### Handling Incomplete Criteria

When a piece of work cannot be fully completed in the current pull request:
- Explain why a criterion is incomplete in the *Implementation Evidence* column.
- Link to follow-up issues if applicable.
- Clearly distinguish completed work from future work.
- Avoid marking incomplete work as complete (use `Partial` or `Not Implemented`).

<!-- Map each acceptance criterion to implementation or verification evidence using the audit template below. -->

**Acceptance criteria confirmation:**

| Acceptance criterion | Implementation or evidence | Status |
| --- | --- | --- |
| <!-- Criterion --> | <!-- File, test, screenshot, or explanation --> | Pass / Not applicable |
| Acceptance Criterion | Implementation Evidence | Test Evidence | Documentation Impact | Status |
| --- | --- | --- | --- | --- |
| <!-- Criterion --> | <!-- File, screenshot, or explanation --> | <!-- Test file or manual check --> | <!-- Docs changed, or N/A --> | Complete / Partial / Not Applicable / Not Implemented |

### Final Confirmation

Expand Down