docs: add meaningful change threshold guide (#148) - #155
Merged
El-swaggerito merged 1 commit intoJul 29, 2026
Merged
Conversation
Adds docs/meaningful-change-threshold.md explaining that line count alone is not the standard for judging PR completeness, with small-but-complete vs small-but-incomplete examples, insufficient-change patterns, and reviewer scope-assessment guidance. Cross-links it from README.md, the Meaningful Implementation Checklist, and the Contributor Evaluation Policy so it doesn't duplicate their existing content. Closes #148
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.
Description
Adds a dedicated "Meaningful Change Threshold" guide for Aegis Contracts PRs, per #148. Some PRs have landed with very small diffs that don't solve the underlying issue; this guide makes explicit that line count is not the standard — completeness against the issue's acceptance criteria is — and gives contributors and reviewers a concrete way to judge it.
New doc:
docs/meaningful-change-threshold.md, which:#[allow]stand-ins, confirm partial scope is disclosed — and apply the same standard regardless of diff size.It is scoped to avoid duplicating
docs/meaningful-implementation-checklist.md(the technical completeness bar — auth/events/errors/tests) — the two docs now cross-link to clarify the division of labor. Also linked from README.md and added to the Related Documents list indocs/contributor-evaluation-policy.md.Related Issues
Closes #148
Completion Table
docs/meaningful-change-threshold.md(new file)README.md— new bullet in## CI & ContributingDetailed Traceability Mapping
Not applicable — this PR makes no storage, event, or security-control changes (documentation only).
Type of Change
PR Evidence Checklist
1. Issue Reference
2. Implementation Summary
docs/meaningful-change-threshold.md(new) — the guide itself.README.md— links the guide from## CI & Contributing.docs/meaningful-implementation-checklist.md— adds a cross-reference to the new guide.docs/contributor-evaluation-policy.md— adds the new guide to## Related Documents.3. Tests Added or Justification
src/logic, so there is no behaviour forsrc/test.rsto cover.make testis unaffected and passes as before (no contract code touched).4. Commands Run
make verifynot applicable to a docs-only diff (no Rust source changed); confirmed nosrc/,tests/,Cargo.toml, orMakefilefiles are touched bygit diff --stat.5. CI Status
6. Acceptance Criteria Coverage
Policy & Standards
Additional Context
This directly responds to the issue's stated concern about very small merged PRs that don't resolve the underlying issue. The new guide is deliberately narrow in scope (judging scope/completeness) so it complements rather than duplicates the existing
meaningful-implementation-checklist.md(technical bar) andaegis-contracts-examples.md(failure-category gallery).