Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
17 lines (14 loc) · 907 Bytes

CONTRIBUTING.md

File metadata and controls

17 lines (14 loc) · 907 Bytes

Table of Contents generated with DocToc

Contributing

  1. Fork this repo ^
  2. Install poetry, pre-commit, doctoc (Run python3 -m pip install poetry pre-commit doctoc)
  3. Run poetry install and pre-commit install from the root directory of the project.
  4. Add your feature/bugfixes/changes (see Roadmap if your are looking for Ideas)
  5. Run ./scripts/check.sh to correct the code styling and lint using pre-commit hooks.
    1. run git add . if the script modified any files.
    2. commit the changes using git commit
  6. Create a pull request with a desriptive title :)
⚡