Add issue approval readiness checklist (#144) - #160
Merged
Conversation
- Create docs/evaluation-readiness-index.md (central index page linking to all evaluation-readiness requirements) - Create docs/ci-guidance.md (CI pipeline steps, local checks, common fixes) - Create docs/acceptance-criteria-audit.md (criteria-to-evidence mapping) - Create docs/self-assessment-checklist.md (pre-submit review checklist) - Update README.md to link to evaluation-readiness index from contrib resources
- Create docs/issue-approval-readiness-checklist.md covering: - Implementation completeness, testing expectations, CI status - Acceptance criteria review, documentation, known limitations - Merge != evaluation disclaimer referencing payment guide - Self-review flow for requesting GrantFox evaluation - Update README.md to link to checklist from key resources
Contributor
| \nThis PR is currently blocked by merge conflicts.\n\nPlease update the branch with the latest main branch and resolve the conflicts before it can be merged. |
Contributor
| \nGitHub has not finished calculating whether this PR can be merged cleanly.\n\nThe auto-merge automation will skip this PR for now. Re-run the automation later. |
Contributor
Author
|
@El-swaggerito finish fix merge pr |
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.
Description
Creates an Issue Approval Readiness Checklist that contributors and reviewers can use before considering an issue ready for GrantFox evaluation. The checklist covers all key areas — implementation completeness, testing expectations, CI status, acceptance criteria review, documentation, and known limitations — and explicitly states that merged PRs are still subject to evaluation.
Closes: #144
Type of Change:
Evidence Checklist
1. Issue Reference
Closes #144)2. Implementation Summary
docs/issue-approval-readiness-checklist.md(new) — Pre-evaluation checklist with 6 sections: implementation completeness, testing expectations, CI status, acceptance criteria review, documentation, and known limitations. Includes a prominent "Merge ≠ Evaluation" disclaimer at the top and a self-review flow at the endREADME.md(modified) — Added the new checklist to the key resources list, right after the evaluation-readiness index3. Testing
Documentation-only change — no testable logic was introduced. The new document is a Markdown checklist file.
Test Commands Run:
Test Output (summary or screenshot):
Documentation-only change — all existing tests, lint, and build checks are unaffected.
4. Commands Run
npm run lint npx tsc --noEmit npm run build npm test5. CI Status
6. Acceptance Criteria Coverage
docs/issue-approval-readiness-checklist.mddocs/issue-approval-readiness-checklist.md(line 11-13)docs/issue-approval-readiness-checklist.md(section 2)docs/issue-approval-readiness-checklist.md(section 3)docs/issue-approval-readiness-checklist.md(section 4)README.mdScreenshots / Recordings
N/A — documentation-only change.
Reviewer Notes
This checklist complements the existing Self-Assessment Checklist (for pre-submit use) and the Review Quality Checklist (for reviewers). It fills the gap between PR merge and GrantFox evaluation, giving contributors a clear final gate to pass before requesting payment review. All references link to existing docs.