27 lines
778 B
Markdown
27 lines
778 B
Markdown
# 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!
|