docs: add issue approval readiness checklist - #174
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Conversation
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
2 participants
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.
Closes #140
Description:
Summary
This PR adds an issue approval readiness checklist to ensure contributors and reviewers have a clear set of expectations before considering an issue fully resolved and ready for evaluation.
Changes Included
docs/issue-approval-readiness-checklist.md.README.mdunder the "CI & Contributing" section to include a link to the new checklist as a mandatory read.Acceptance Criteria Covered
Motivation
Contributors previously assumed their work was complete simply because a PR was merged, which often left gaps in testing, documentation, or core acceptance criteria. This checklist acts as a definitive guide for evaluating implementation completeness, verifying tests and CI, assessing acceptance criteria, ensuring proper documentation, and noting any known limitations.