ziproot
/
HOP
1
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Update CONTRIBUTING.md

This commit is contained in:
PeacefulPotato 2020-12-04 15:11:48 -05:00 committed by GitHub
parent 13b5ed9044
commit e8eafd2cee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
CONTRIBUTING.md
View File

@ -1,5 +1,5 @@
# Issues # Issues
There are three types of issues: Bugs, Questions and Enhcanements. There are three types of issues: Bugs, Questions and Enhcanements. For all issues, make sure you aren't posting a duplicate.
## Bugs ## Bugs
Bugs are things that are supposed to work but don't. Bugs are things that are supposed to work but don't.
Some examples include: Some examples include:
@ -14,22 +14,14 @@ Non examples include:
If you find a bug, label it with the "bugs" tag, as well as the "security" tag if the bug relates to security. Then, be sure to label it based on the bug report template. If you find a bug, label it with the "bugs" tag, as well as the "security" tag if the bug relates to security. Then, be sure to label it based on the bug report template.
## Questions ## Questions
Questions are things that you are unsure about. When in doubt, mark it as a question. If you have a question, label it based on the question template. Questions are things that you are unsure about. When in doubt, mark it as a question, though be sure to always answer it yourself before posting. Be sure to format the enhancement as dicated in the feature request template, though be sure to always answer it yourself before posting.
## Enhancements ## Enhancements
Enhancements are things you want to improve. Be sure to list it both as an enhancement and label it based on what type of enhancement it is: Enhancements are things you want to improve. Be sure to label it based on what type of enhancement it is:
Security: This is an improvement to security you would like to see, such as RSA encryption. Security: This is an improvement to security you would like to see, such as RSA encryption.
QOL: This is an improvement to quality of life you would like to see, such as more lanugages as codes. If in doubt, mark it as QOL. QOL: This is an improvement to quality of life you would like to see, such as more lanugages as codes. If in doubt, mark it as QOL.
Documentation: This is an improvement to documentation you would like to see. Documentation: This is an improvement to documentation you would like to see.
Be sure to label the enhancement based on the feature request template. Be sure to format the enhancement as dicated in the feature request template.
# Pull Requests # Pull Requests
Pull requests are when you want to change the code yourself. Please link to any relavent issues by clicking on the gear next to "linked issues". Pull requests are when you want to change the code yourself. Please link to any relavent issues by clicking on the gear next to "linked issues".
Additionally, add this to the milestone the issues are linked to, and label it based on what you are trying to solve (Bug or Enhancement and what type if necessary). Additionally, add this to the milestone the issues are linked to, and label it based on what you are trying to solve (Bug or Enhancement and what type if necessary).
They should be formatted as follows: They should be formatted as dictated in the pull request template.
```
**Changes**
A bulleted list of the changes you made. Will be used in release notes.
**Reasoning**
Why you want to make these changes. Should be clear and concise.
**Drawback Handling**
Potential drawbacks in this change and how you addressed them.
```