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 10:28:54 -05:00 committed by GitHub
parent ed4872fa01
commit 5a59e7fd09
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
CONTRIBUTING.md
View File

@ -12,56 +12,15 @@ Non examples include:
* Adding something new, instead of fixing something old
* Asking a question about something you don't get
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 as follows:
```
**Issue Description**
Description of your issue
**System Details**
* Interpreter version X (i.e. repl.it or IDLE version 2020-09). If using a command prompt, say the name of the program you enter, like "python3", and the version, using --version.
* HOP Encode/Decode (which program is malfunctioning)
**Steps to reproduce**
Make sure that the steps can be easily followed.
1. Do step 1
2. Do step 2
3. Do step 3
etc.
**Expected behavior**
What is supposed to happen
**Actual behavior**
What actually happened
**Exception**
If you got an exception, list it below.
`Exception`
**Screenshots**
Any screenshots you deem necessary. Optional, but helpful.
```
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 are things that you are unsure about. When in doubt, mark it as a question. If you have a question, label it in the following manner:
```
**Question**
Make sure you are clear and concise. Clear means the average person can understand what you want to know, and concise means the question isn't too long.
**System Details**
* Interpreter version X (i.e. repl.it or IDLE version 2020-09). If using a command prompt, say the name of the program you enter, like "python3", and the version, using --version.
* HOP Encode/Decode (which program you are confused about)
**Screenshots**
Any screenshots you deem necessary. Optional, but helpful.
```
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.
## 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:
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.
Documentation: This is an improvement to documentation you would like to see.
Be sure to label the enhancement as follows:
```
**Program to Enhance**
What you want to enhance. Examples include HOP Encode and HOP Decode.
**Description of Enhancement**
A clear and concise descrpition of how you want to enhance the program.
**Approach**
Possible ways to accomplish this enhancement.
**Screenshots**
Any screenshots you deem necessary. Optional, but helpful.
```
Be sure to label the enhancement based on the feature request template.
# 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".
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).