Skip to content

Latest commit

 

History

History
64 lines (41 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

64 lines (41 loc) · 1.66 KB
Raw

How to contribute

Creating a Separate virtualenv

Before you contribute on this project you need to create a new separate virtualenv.

Here is one example.

python -m venv .env
source .env/bin/activate

Dependencies

We have listed all the python dependencies in the requirements.txt files.

Pre-commit Hook

The config file for pre-commit hooks is in .pre-commit-config.yaml file. To install pre-commit and enable the hook please refer to https://pre-commit.com

Codestyle

A .editorconfig is available to maintain the coding style. Besides, your code will automatically gets formatted if you have install 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 (README.md) if you have changed something significant.
  5. Commit your changes using Conventional Commits.
    Examples: feat: add JSON parser, feat(parser): add JSON parser.

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.