-
Notifications
You must be signed in to change notification settings - Fork 9
Issue and Pull Request Formatting
Ewen Dai edited this page Aug 28, 2019
·
2 revisions
Title
- Concise Issue Summary
Body
- Go more into detail about the issue
- If this is a bug, identify the bug and explain exactly how the bug occurs so that we can reproduce it. Include what the expected response is. If possible, include your ideas on how to fix the bug. Please attach screenshots where possible.
- If this is an enhancement, please explain what you want to see on our webpage. If possible, please include a design/visual/in depth details so we can better understand what the enhancement is.
- If this is a maintenance/update request, provide all the information needed to proceed with the update.
- Include a link to the exact page on our website where the issue is located.
- Please tag your issues where possible. Tag the issue as “Unknown” if you are not sure.
- Most importantly, please write in clear sentences/phrases so that even someone with no experience working with our repo can understand what you are talking about.
Title
- If the issue was a bug: “Fix [insert summary of bug]”
- If the issue was an enhancement: “Add [enhancement]”
- If the issue was an update: “Update [what was updated]”
- etc.
Body
- How the issue was resolved
- Close the Issue: “Close #1234” for Issue #1234
Everything should be in present tense with proper grammar.