Improve contribution templates and guidelines for better PR descriptions #171
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.
This PR addresses the poor quality contribution snippets that were causing confusion and incomplete PR descriptions, as evidenced by issues #134, #135, #144, #150, and #152.
Problem
The existing contribution templates were causing several issues:
This resulted in PRs with descriptions like:
Solution
Enhanced PULL_REQUEST_TEMPLATE.md:
Improved CONTRIBUTING.md:
Updated README.md:
Impact
Contributors now have:
These changes address the root cause of the poor PR descriptions seen in the referenced issues by providing educational, structured guidance that helps contributors write better submissions from the start.
Fixes #155.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.