docs: link low-effort contribution examples in README - #155
Merged
Code-Paragon merged 1 commit intoAug 13, 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.
Closes #117
Summary:
This PR satisfies the requirement to document low-effort contribution examples for the Aegis SDK by linking the comprehensive
low-effort-pr-examples.mdguide directly from the mainREADME.md.Current Behaviour:
Contributors may not have easily discovered the quality standards and reasons why small, merged PRs with minimal changes fail evaluation, as the examples document wasn't linked in the repository's main entry point.
Expected Behaviour:
The main
README.mdnow explicitly links to thedocs/low-effort-pr-examples.mdguide, providing high visibility to examples of superficial changes, partial implementations, missing-test submissions, and failing-CI submissions, along with their improved alternatives.Changes:
README.mdunder the "Contributing" section to include a direct link todocs/low-effort-pr-examples.mdoutlining the quality standards for accepted contributions.Acceptance Criteria Met: