Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.17 KB

HOW-TO-CONTRIBUTE.md

File metadata and controls

45 lines (31 loc) · 1.17 KB
Raw

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. Clone the repo into your local machine.
  4. Create a new branch for your changes.
  5. Start hacking :-)

Not familiarized with the Python workflow?

  1. Be sure that you have Python 3 and virtualenv installed (if not, install them)
  2. Create a new virtualenv
  python -m virtualenv env -p python3
  1. And activate it!
  2. Now it's time to install the dependencies.
  pip install -r requirements.txt
  1. And now you're ready to hack.

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!