How to contribute¶
We use poetry to manage the dependencies.
To install them you would need to run
To activate your
One magic command¶
make test to run everything we have!
flake8 for quality control.
We also use wemake_python_styleguide to enforce the code quality.
To run all tests:
To run linting:
Keep in mind: default virtual environment folder excluded by flake8 style checking is
If you want to customize this parameter, you should do this in
These steps are mandatory during the CI.
mypy to run type checks on our code.
To use it:
mypy scdlbot tests/**/*.py
This step is mandatory during the CI.
Submitting your code¶
We use trunk based
development (we also sometimes call it
What the point of this method?
We use protected
masterbranch, so the only way to push your code is via pull request
We use issue branches: to implement a new feature or to fix a bug create a new branch named
Then create a pull request to
git tags to make releases, so we can track what has changed since the latest release
So, this way we achieve an easy and scalable development process which frees us from merging hell and long-living branches.
In this method, the latest version of the app is always in the
Before submitting your code please do the following steps:
pytestto make sure everything was working before
Add any changes you want
Add tests for the new changes
Edit documentation if you have changed something significant
CHANGELOG.mdwith a quick summary of your changes
pytestagain to make sure it is still working
mypyto ensure that types are correct
flake8to ensure that style is correct
doc8to ensure that docs are correct
You can contribute by spreading a word about this library. It would also be a huge contribution to write a short article on how you are using this project. You can also share your best practices with us.