docs: add acceptance criteria audit template for PRs - #538
Merged
Conversation
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.
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
Currently, contributors can complete only part of an issue while claiming completion. Reviewers have no standardized way to verify implementation completeness, testing, and documentation updates across pull requests. This lack of structure leads to inconsistent reviews, ambiguous states for incomplete work, and unnecessary back-and-forth between maintainers and contributors.
Implementing a formalized audit template forces contributors to explicitly break down their evidence for every criterion, vastly improving review quality and clarity.
Summary
This pull request introduces a comprehensive 5-column Acceptance Criteria Audit Template to the PR process. It replaces the simple 3-column table previously used and adds clear guidelines on how to report evidence and handle partially completed work.
What Changed
Implementation Evidencesection to the template.Test Evidencesection to the template.Documentation Impactsection to the template.docs/contributor-self-assessment.md) with usage guidance..github/pull_request_template.md) to include the new table format.Why This Matters
Testing
Documentation
.github/pull_request_template.mddocs/contributor-self-assessment.mdAcceptance Criteria Checklist
Future Improvements
Statuscolumn for any criterion is left blank or uses an invalid value.evaluation-readiness-checklist.mdcould be updated in the future to mandate a final pass of this specific 5-column audit.Related Issue
Closes #496