Contributing

Thanks you for investing your time in our project! You can easily ask a question by creating an appropriate topic with a problem on the Github repository.

Types of contributing

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Testing

Not enough tests! The project contains several tests in the tests/ folder.

1. Install required dependencies:

$ poetry install

2. And you can easily use tests by entering the following command:

$ python -m unittest