KomSuite/KomSuite-NyaaPy
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases 3 Wiki Activity

Create HOW-TO-CONTRIBUTE.md

Browse Source
This commit is contained in:
Juanjo Salvador
2018-10-09 19:45:21 +02:00
committed by GitHub
parent 9b5238b87e
commit 7026ad6722
1 changed files with 26 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
HOW-TO-CONTRIBUTE.md Normal file
View File

@@ -0,0 +1,26 @@
# How to contribute with this project
## Getting started
1. Star the repo, it will help me a lot.
2. Make a fork for you.
3. Use the `dev` branch, never master.
## Hacking
1. Please, make sure your code is valid according the PEP8 specification
2. If you want to add a new feature, not planned yet, open an issue first.
3. Fix the issues tagged as bug, then we can fix the issues related with features and improvements.
4. Add comments to your code, don't be shy.
## Hacktoberfest plus
If this is your first time, follow this steps:
1. Go to `Getting started` and follow the instructions there.
2. Push your changes into your fork.
3. Open a PR across forks from your `dev` branch to parent's repo `dev` branch (NOT MASTER)
4. Wait for feedback
Happy coding!