docs: add contributor self-review form - #206
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Merged
Conversation
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
2 participants
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.
Summary
Expands the existing contributor self-assessment document into a complete self-review form that contributors can use before requesting maintainer review or expecting GrantFox payment approval.
The form provides structured readiness checks and evidence fields covering requirements, implementation completeness, testing, CI, documentation, acceptance criteria, and known limitations.
Closes #144
Changes
Added contribution details and clear self-review outcomes.
Added a dedicated requirements-review section.
Added an implementation-completeness assessment.
Expanded testing-evidence questions and evidence fields.
Added structured local verification and CI status reporting.
Added documentation and examples review.
Expanded known-limitations and residual-risk reporting.
Added acceptance-criteria mapping.
Added a final contributor declaration.
Added the self-review form to the README documentation index.
Testing performed
Documentation-only change.
Ran git diff --check.
Confirmed all required self-review sections are included.
Reviewed the complete documentation diff.
Confirmed referenced documentation paths exist.
No runtime code, packages, applications, contracts, tests, or CI configuration were changed.
Acceptance criteria
Self-review form is added.
Requirements review is included.
Implementation completeness is included.
Testing evidence is included.
CI status is included.
Known limitations are included.
Documentation impact
Updated:
docs/CONTRIBUTOR_SELF_ASSESSMENT_FORM.md
README.md
Known limitations
None identified. This contribution changes documentation only and does not modify repository runtime behaviour.