Contributing

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub

Reporting issues and providing feedback

If you find any bugs, be sure to open up an issue. You can also send me an email: [email protected]

Python 3 (versions 3.12+ are currently supported)
pip3 install flake8 pytest nose
flake8 to check for errors and to enforce code style.
pytest to run the tests (optional, you can contribute without writing tests).
Install all requirements with the following command:
```
  pip3 install -r requirements.txt
```
~~If you're making changes to the documentation, install the documentation~~ ~~dependencies: pip3 install -r docs/requirements.txt.~~
~~You can find~~ ~~a brief introduction to reStructuredText in the Sphinx documentation.~~

Note: This project uses absolute imports (recommended by PEP8). So, you'd be better off using a virtual environment.

Select an issue to work on.
Fork and clone the repository, create a virtual environment and install all the dependencies:
```
  $ pip3 install -r requirements.txt
```
Work on the master branch for smaller patches or create a separate branch for new features.
Make changes, git add and then commit. You can link to the issue number in the commit message (optional).
Use the GitHub website to create a Pull Request (PR) and wait for the maintainers to review it.
(Optional) Run flake8, pytest and black.
~~(Optional) If you're updating the documentation, make sure you update docs/index.rst and README.md simultaneously.~~

This project uses the PEP8 code style. Your should follow the same before you create a pull request. You can use black to format your code quickly.
Every function in your code should have a docstring that follows Google Python Style Guide.