Hi there, and thank you for considering contributing to fastx-barber to help us make our code a better version of itself!
fastx-barber is an open source project, and as such any kind of contribution is welcome! There are many ways in which you can contribute: improve the code or the documentation, submit bug reports, request new features or write tutorials or blog posts.
To see what kinds of behavior are acceptable when contributing to fastx-barber, please refer to our code of conduct.
We host fastx-barber on GitHub, where we also track issues and feature requests, as well as handle pull requests.
Please, note that any contributions you make will be under the MIT Software License. In other words, all your submissions are understood to be under the same MIT License that covers the fastx-barber project. Feel free to contact us if that's a concern.
To process code change, we follow the Github Flow. All code changes to our main branch happen through pull requests from the dev branch. We actively welcome your pull requests to the dev branch!
If you want to report a bug, please use the github issue tracker and follow the issue template that should automatically show up.
If you would like to see a new feature implemented in fastx-barber, or to have an already existing feature improved, please use the github issue tracker and follow the template that should automatically show up.
We like to have fastx-barber code styled with black and checked with mypy. mypy, flake8, and black conforming checks are automatically ran on all pull requests through GitHub Actions.
If your code changes fastx-barber dependencies, we recommend to change them in the pyproject.toml file and then regenerate requirements.txt by running:
poetry export -f requirements.txt -o requirements.txt --without-hashes
See poetry's documentation for more details on the format of the pyproject.toml file.