diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 62afcbb..2e40c9f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,10 @@ We welcome open-source contributions! As middleware, this SDK is critical for the frontend developer experience. +Before opening a PR, see the [Evaluation-Readiness Index](docs/evaluation-readiness-index.md), +which links every payment, testing, CI, acceptance-criteria, self-assessment, +reviewer, and communication doc from one page. + ## Development Workflow 1. **Fork & Clone:** Fork the repo and clone it locally. 2. **Install Dependencies:** Run `npm install`. diff --git a/README.md b/README.md index 0ccdb4d..c69c6cb 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,10 @@ For step-by-step instructions on reproducing and fixing CI check failures, see t ## Contributing We welcome contributions! Please check our [CONTRIBUTING.md](CONTRIBUTING.md) for our branching strategy and code style guidelines. +Before you start, see the [Evaluation-Readiness Index](docs/evaluation-readiness-index.md) +for one central page linking every payment, testing, CI, acceptance-criteria, +self-assessment, reviewer, and communication requirement. + Before submitting a PR, follow our [Test-First Contribution Guide](docs/test-first-contribution-guide.md) to understand when tests are required, what type of tests are expected per module, and how to prove your change works correctly. ### Review Process diff --git a/docs/evaluation-readiness-index.md b/docs/evaluation-readiness-index.md new file mode 100644 index 0000000..11ebb1b --- /dev/null +++ b/docs/evaluation-readiness-index.md @@ -0,0 +1,68 @@ +# Evaluation-Readiness Index + +> **Applies to:** Aegis SDK (`@aegis/sdk`) +> **Last updated:** 2026-07-29 + +This page is the single starting point for everything a contributor needs to +check before, during, and after a GrantFox payment evaluation period. Each +section below links to the authoritative document for that topic instead of +duplicating its content, so this index stays accurate as those docs change. + +## 1. Payment Expectations + +- [Contributor Payment Expectation Guide](contributor-payment-guide.md) — + how GrantFox evaluation and payment work, and how to maximize payout chance. +- [Contributor Evaluation Policy](contributor-evaluation-policy.md) — + how merged contributions are evaluated under compensated programs. +- [Payment-Period Conduct](payment-period-conduct.md) — + expected conduct during and after evaluation periods. + +## 2. Testing Standards + +- [Testing Utilities](testing.md) — the mock client and local test setup. +- [Contributor Test Matrix](contributor-test-matrix.md) — + minimum useful test evidence by feature area. +- [Test-First Contribution Guide](test-first-contribution-guide.md) — + when tests are required and what they must prove. +- [Testing Evidence PR Requirement](testing-evidence-requirement.md) — + what testing evidence a PR description must include. + +## 3. CI Guidance + +- [CI Pass Requirements](ci-pass-requirements.md) — + required passing checks and how CI status affects evaluation. +- [CI Failure Resolution Workflow](ci-resolution-workflow.md) — + reproducing and fixing CI failures locally. +- [Failing CI Response Guide](ci-response-guide.md) — + diagnosing and resolving each type of CI failure. + +## 4. Acceptance Criteria Audit + +- [Acceptance Criteria Audit](acceptance-criteria-audit.md) — + the reusable template mapping each issue criterion to evidence. +- [Acceptance Criteria Traceability Table](acceptance-criteria-traceability.md) — + the required table linking modules, tests, and docs to each criterion. + +## 5. Self-Assessment + +- [Self-Review Template](self-review-template.md) — + checklist to run against your own change before opening a PR. +- [Issue Approval Readiness Checklist](issue-approval-readiness.md) — + what to confirm before marking an issue ready for evaluation. + +## 6. Reviewer Checklist + +- [Pull Request Reviewer Checklist](reviewer-checklist.md) — + the checklist maintainers use to approve and merge a PR. + +## 7. Communication Policy + +- [Payment-Period Communication Policy](payment-period-communication-policy.md) — + how and where to raise evaluation or payout questions. + +## Related References + +- [Pull Request Evidence Checklist](pr-evidence-checklist.md) +- [Meaningful Implementation Checklist](meaningful-implementation-checklist.md) +- [Meaningful Change Threshold Guide](meaningful-change-threshold.md) +- [Low-Effort PR Examples & High-Quality Standards](low-effort-pr-examples.md)