It's an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into pybitrix24 itself.
All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.
Before you submit an issue, please search the issue tracker first, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
We want to fix all the issues as soon as possible, but before fixing a bug we need to reproduce and confirm it. In order to reproduce bugs we ask you to provide a minimal reproduction scenario that include:
- Version of the client used.
- Environment information (3rd-party libraries, technology stack etc.).
- A use-case that fails!
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
If you would make PR for something that is bigger than a one or two line fix:
- Be sure you are following:
- The code style for the project: PEP-8.
- Commit message convention: sentence case, present time.
- Create your own fork of the code.
- Do some changes in your fork.
- Add automated tests covering the changes.
- Submit a pull request.
- Replace environment variables with real values in Makefile.
- Run all automated tests (unit and E2E):
make test