Recommended Community Standards for the Repository
Opened this issue · 2 comments
Description
Referring to the Community Standards being provided by the GitHub , would it be a better idea to add a PR Template and an Issue Template. Listing a few suggestive points so that a contributor or an issue raiser would find useful to raise impactful and review-friendly PR(s) before actually raising it to the repository. The Issue Template would also help to go through the issues efficiently by a maintainer.
PR Template
- Description (a short description explaining the intention behind raising it, would be better to keep it in few 1 or 2 lines)
- Changes Made (a numbered list of items comprising of changes made)
- Before and After Comparison (if exists)
- Approach Used (explaining why using that approach and the benefits of using it)
Issue Template
- Description (a short para or listing them as item-wise would be better)
- Missing Things
- Expected Results/ Outcome
@aswaterman let me know your view points. We can add templates so that a PR/ Issue raiser will get the editable templates before raising it by enabling the markdown files. They can change them as per their own wish, but the template will get render as soon as they raise it to have an idea about what this repository is expecting a raiser to provide.
Looping @rpsene if he is having some points to share regarding the same.
Truth be told, I'm not a huge fan of these templates: many people ignore them, and so they end up adding clutter but little value. But if the other users of this repo have a favorable opinion, I'm happy to go along.