Skip to content

docs: add issue approval readiness checklist - #161

Open
peterexcel494-oss wants to merge 1 commit into
Raegis-RWA:mainfrom
peterexcel494-oss:feat/issue-113-approval-readiness-checklist
Open

docs: add issue approval readiness checklist#161
peterexcel494-oss wants to merge 1 commit into
Raegis-RWA:mainfrom
peterexcel494-oss:feat/issue-113-approval-readiness-checklist

Conversation

@peterexcel494-oss

Copy link
Copy Markdown

Summary

Adds a comprehensive Issue Approval Readiness Checklist for Aegis SDK contributors, addressing all acceptance criteria from issue #113.

Changes

  • docs/approval-readiness-checklist.md — New checklist document with six structured sections:

    1. Implementation Completeness — scope alignment, acceptance criteria coverage, no placeholder logic
    2. Testing Expectations — happy-path and failure-mode coverage, mock client usage, no-test justification for docs-only changes, npm run verify gate
    3. CI Status Expectations — all GitHub Actions checks green, Node 20/22 matrix, build/lint/compat pass
    4. Acceptance Criteria Review — traceability table requirement, per-criterion evidence, deferred items tracked
    5. Documentation — API reference, README, guides updated as needed
    6. Known Limitations — edge cases documented, follow-up issues linked
    • Contributor Self-Review Summary checklist
    • "Merged Does Not Mean Evaluated" section explicitly stating merge ≠ reward eligibility or campaign completion
    • Related documentation links
  • README.md — Added "Issue Approval Readiness" subsection in Contributing with a direct link to the new checklist and a callout that a merged PR is still subject to evaluation.

Acceptance Criteria

Criterion Satisfied by
Approval readiness checklist is added docs/approval-readiness-checklist.md created with all 6 sections
Checklist states merged PRs are still subject to evaluation "Merged Does Not Mean Evaluated" section + README callout
Testing expectations are included Section 2: Testing Expectations
CI status expectations are included Section 3: CI Status Expectations
Acceptance criteria review is included Section 4: Acceptance Criteria Review
README links to the checklist README.md Contributing > Issue Approval Readiness

Closes #113

- Add docs/approval-readiness-checklist.md with six sections:
  implementation completeness, testing expectations, CI status,
  acceptance criteria review, documentation, and known limitations
- Include contributor self-review summary checklist
- Add 'Merged Does Not Mean Evaluated' section explicitly stating
  that a merged PR is still subject to evaluation for reward eligibility
- Update README.md Contributing section with link to the new checklist
  and a note that merge does not confirm campaign completion

Closes #113
@peterexcel494-oss

Copy link
Copy Markdown
Author

l have work on the issues but not showing PR on my dashboard and not yet giving point
but showing me completed pls kindly review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Aegis SDK issue approval readiness checklist

1 participant