We appreciate all kinds of help, so thank you! 👏 😘
You can contribute in many ways to this project.
🔥 This is a goog point to start, when you find a problem please add it to the issue traker. The ideal report should include the steps to reproduce it.
👭 To help less advanced users is another wonderful way to start. You can help us to close some opened issues. This kind of tickets should be labeled as question.
😈 If you have an idea for a new feature please open a ticket labeled as enhancement. If you could also add a piece of code with the idea or a partial implementation it would be awesome.
👀 We all know the doc always need fixes/upgrades 😉, so please feel free to send a PR (see next point) with what you found.
⭐ This section include some tips that will help you to push source code.
Needed libraries should be installed in this way:
make env-devNew features often imply changes in the existent tests or new ones are needed. Once they're updated/added run this be sure they keep passing:
make testSubmit clean code and please make effort to follow existing conventions in order to keep it as readable as possible. We use Pylint and PEP 8 style guide, to confirm the new stuff respects it run the next command:
make lintReview the parts of the documentation regarding the new changes and update it if it's needed.
We use GitHub pull requests to accept the contributions. You can explain yourself as much as you want 😄. Please follow the next rules for the commit messages:
- It should be formed by a one-line subject, followed by one line of white space. Followed by one or more descriptive paragraphs, each separated by one line of white space. All of them finished by a dot.
- If it fixes an issue, it should include a reference to the issue ID in the first line of the commit.
- It should provide enough information for a reviewer to understand the changes and their relation to the rest of the code.