Skip to content

docs: add low-effort PR examples and quality expectations document (C… - #186

Merged
Code-Paragon merged 1 commit into
mainfrom
docs/103-low-effort-pr-examples
Aug 13, 2026
Merged

docs: add low-effort PR examples and quality expectations document (C…#186
Code-Paragon merged 1 commit into
mainfrom
docs/103-low-effort-pr-examples

Conversation

@Code-Paragon

Copy link
Copy Markdown
Contributor

Summary

Adds comprehensive documentation detailing what constitutes a "low-effort" PR in aegis-contracts to set clear evaluation standards and reduce contributor friction (Closes #103).

Closes #103

Changes

  • Created docs/low-effort-pr-examples.md:
    • Details 4 common anti-patterns: superficial cosmetic changes, under-tested logic, unsafe Rust (unwrap/panic), and ignored CI failures.
    • Provides clear, side-by-side examples of "Unacceptable" code vs. "Expected Alternative" code.
    • Concludes with a checklist of what a successful, high-effort PR looks like.
  • Updated README.md: Linked the new guide in the Testing/Contributing section right next to the failing CI guide.

Checklist

  • Tests added or updated
  • Docs updated (if user-facing behavior changed)
  • CI is green (all checks pass)
  • Branch name follows issue/<number>-<slug> or feat/<number>-<slug>
  • Cargo.lock not modified

@Code-Paragon
Code-Paragon merged commit 5776a11 into main Aug 13, 2026
1 check passed
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 contracts low-effort PR examples document

2 participants