Skip to content

Contributing

Here you can fing a quick guide on how to contribute with the project.

Steps to follow

Fork the repository

First, you need to fork the repository to your GitHub account. Click on the “Fork” button on the top right corner of the repository page.

Create a branch

Create a new branch based on the develop branch with a objective name for your contribution:

Terminal
git checkout -b feature/your-feature-name develop

Develop your changes

If you need help to quickstart the local environment, check the Getting Started guide.

Preparing the commit

After all changes done, check for lint errors and format the code:

Terminal
pipenv run isort . && pipenv run black .

Opening a pull request

All done? Now you can push your changes to your forked repository and open a pull request to wait for a review.

Further reading