Skip to content

Latest commit

 

History

History
41 lines (28 loc) · 2.13 KB

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 2.13 KB
Raw

How to contribute

Installing dev dependencies

To get started you would need to install python3.9 and poetry. Please follow the instructions on their official websites.

  • We use poetry to manage our python dependencies. Please make sure that poetry is added to your PATH variable after installation and you can run poetry command in your terminal or command prompt.

  • After cloning the opensourceleg repository, please activate your virtualenv by running poetry shell command. This will create an isolated virtual environment for development.

  • To install dependencies and prepare pre-commit hooks you would need to run these commands from the root of the repository:

    make install
make pre-commit-install

Submitting your code

Many checks are configured for this project.

  • Command make check-codestyle will check black, isort and darglint.
  • Command make lint will check types, docstrings and security using Mypy, Darglint, Pydocstyle
  • Command make check-safety will look at the security of your code and dependencies using Safety and Bandit.

Before submitting your code please do the following steps:

  1. Add any changes you want
  2. Add tests for the new changes
  3. Edit documentation if you have changed something significant
  4. Run make codestyle to format your changes.
  5. Run make lint to ensure that types, security and docstrings are okay.
  6. Run make check-safety to ensure that your code is secure.

Your code will be checked by our CI/CD pipeline once you submit a pull request. Happy coding!

Other ways you can 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.