docs: add central evaluation-readiness index page (#122) - #154
Open
rexx010 wants to merge 1 commit into
Open
Conversation
Add docs/evaluation-readiness-index.md as the single page that links every evaluation-readiness requirement: payment expectations, testing standards, CI guidance, acceptance criteria audit, self-assessment, reviewer checklist, and communication policy. Link the new index from README.md's Contributing section and from the top of CONTRIBUTING.md so contributors discover it before opening a PR. Closes #122
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.
Closes #122
Summary
Adds one central page,
docs/evaluation-readiness-index.md, that links everyevaluation-readiness requirement for contributors instead of leaving that
guidance scattered across the README, PR template, testing docs, and CI docs.
What changed
docs/evaluation-readiness-index.md(new file, 68 lines)New index page with 7 sections, each linking to the existing authoritative doc:
contributor-payment-guide.md,contributor-evaluation-policy.md,payment-period-conduct.mdtesting.md,contributor-test-matrix.md,test-first-contribution-guide.md,testing-evidence-requirement.mdci-pass-requirements.md,ci-resolution-workflow.md,ci-response-guide.mdacceptance-criteria-audit.md,acceptance-criteria-traceability.mdself-review-template.md,issue-approval-readiness.mdreviewer-checklist.mdpayment-period-communication-policy.mdPlus a "Related References" section linking
pr-evidence-checklist.md,meaningful-implementation-checklist.md,meaningful-change-threshold.md,and
low-effort-pr-examples.md. The page links out to each doc rather thanduplicating content, so it can't go stale relative to the source docs.
README.md(+4 lines, at line 143)Added a pointer to the new index right under the existing Contributing
heading, so it's visible before a contributor reads further.
CONTRIBUTING.md(+4 lines, at line 5)Added the same pointer at the top of the file, before the Development
Workflow section, so it's the first thing a contributor sees.
Acceptance criteria mapped
docs/evaluation-readiness-index.md(new, 68 lines)contributor-payment-guide.mdtesting.md+contributor-test-matrix.mdci-pass-requirements.md+ 2 moreacceptance-criteria-audit.md+ traceability tableWhy no code/test changes
This is a documentation-only change (issue type: Documentation). No
src/,tests/,.github/, orpackage.jsonchanges were needed — the issue's"Files or Areas Likely Affected" list was a superset of possible touch points,
and only
docs/,README.md, andCONTRIBUTING.mdwere actually required tosatisfy the acceptance criteria.
Testing evidence
Full suite run before the change (baseline,
main):Full suite run after applying this change (branch
docs/evaluation-readiness-index-122):Identical results before and after (117/117 tests, clean build, clean compat
checks) — expected, since this PR only touches Markdown files under
docs/and two root-level
.mdfiles.