How to contribute

In our development process we followed practices described by Uncle Bob in his magnificent “Clean Code”. Please, consult this book in case any trouble.

Make a fork of this repository, and develop your own tool. Make sure it is error-free and the test coverage is at least 60 percent. Update config files accordingly, and check their operability.

While producing your code, use this famous git workflow. Also note that our branches use prefixes feature/, fix/, and ci-cd/.

Further, send a pull request. In the comment, write the main features of the tool, the technology stack used, and a brief description of the algorithms. This should be enough for us to accept your code.

To check the quality of the code, we use flake8 and codacy.