Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ value-encoding rules, and the no-real-user-data guarantee.

See [Failing CI Response Guide](docs/failing-ci-guide.md) for detailed causes and fixes per category.

- [Issue Approval Readiness Checklist](docs/issue-approval-readiness-checklist.md) — **mandatory checklist** for contributors and reviewers before considering an issue ready for evaluation
- [Evaluation Readiness Summary](docs/evaluation-readiness.md) — **central page** summarizing what makes a contribution evaluation-ready: testing standards, CI workflow, PR evidence, acceptance criteria mapping, self-review, and conduct guidance
- [PR Evidence Checklist](docs/pr-evidence-checklist.md) — **mandatory** evidence checklist for every PR: issue reference, implementation summary, tests, commands run, CI status, and acceptance criteria coverage
- [Local Verification Command](docs/local-verification.md) — run `make verify` (fmt-check + clippy + test + build) before pushing to avoid failing CI
Expand Down
35 changes: 35 additions & 0 deletions docs/issue-approval-readiness-checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# Issue Approval Readiness Checklist

This checklist is for contributors and reviewers to use before considering an issue ready for evaluation.

**Note: A merged PR does not automatically mean an issue is fully resolved or approved. Merged PRs are still subject to evaluation and final approval.**

## 1. Implementation Completeness
- [ ] The code implements all the requirements requested in the issue.
- [ ] Edge cases have been considered and handled appropriately.
- [ ] The solution aligns with the existing architecture and design patterns of the repository.

## 2. Tests (Testing Expectations)
- [ ] Appropriate unit tests have been added or updated to cover the new functionality or bug fix.
- [ ] Integration tests have been added where applicable.
- [ ] All existing tests pass locally.
- [ ] Test coverage is sufficient and covers both happy paths and negative paths (error handling).

## 3. CI Status (CI Status Expectations)
- [ ] All Continuous Integration (CI) checks are passing successfully (e.g., build, tests, linters, formatting).
- [ ] There are no warnings or pending checks that have been ignored.
- [ ] See the [Failing CI Response Guide](failing-ci-guide.md) if you encounter issues.

## 4. Acceptance Criteria (Acceptance Criteria Review)
- [ ] Every specific acceptance criteria listed in the original issue has been verified as completed.
- [ ] Reviewers have validated that the acceptance criteria are met both in code and functionality.
- [ ] Any missing criteria have been explicitly discussed and deferred to a new issue.

## 5. Documentation
- [ ] The `README.md` has been updated if there are changes to setup, configuration, or core functionality.
- [ ] Inline code documentation (docstrings, comments) has been added for complex logic.
- [ ] Relevant guides in the `docs/` folder have been updated to reflect new changes.

## 6. Known Limitations
- [ ] Any known limitations or technical debt introduced by this PR are clearly documented in the PR description.
- [ ] Follow-up issues have been created for identified limitations or future enhancements.