Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.39 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.39 KB
Raw

How to Contribute

Install Development Dependencies (Using Pipenv)

All the dependencies are managed by Pipenv. Please install Pipenv on your system first by following the instructions at https://pipenv.pypa.io/en/latest/installation/.

Once Pipenv is installed, you can install the development dependencies by running the following command:

make install-dev

This will ensure that all the necessary packages and dependencies are installed in your development environment.

Codestyle

A .editorconfig is available to maintain the coding style. Besides, your code will automatically get formatted if you have installed the pre-commit hook.

Unit tests

Run the unittest using the below command:

make test

Coverage Report

To run the coverage report:

make coverage

To generate HTML coverage report

make coverage-html

Before submitting

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Update the CHANGELOG.md file if necessary
  4. Edit documentation if you have changed something significant

Other help

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.