Skip to content

Latest commit

 

History

History
27 lines (23 loc) · 1.11 KB

CONTRIBUTING.md

File metadata and controls

27 lines (23 loc) · 1.11 KB

Contributing

Everybody is invited and welcome to contribute.

I have an idea or found a bug

Please, open a new issue or subscribe to existing.

I want to improve something

Code style: black

Create Pull Request with description of motivation and improvements of your changes. This repository is using:

  1. black codestyle
  2. pre-commit for pre-checks
    pip install -r requirements_test_pre_commit.txt
    pre-commit run --all-files
    
  3. conventional commits
  4. CI/CD practices
    • make sure that your commits pass all existing tests
    pip install -r requirements_test.txt
    pytest
    
    • make sure that all new code is covered by tests
  5. Squash or rebase merging