How to Contribute#

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Code reviews#

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Note : Every PR before require at least 2 approvals to get merged to the master branch.

Run docs with mkdocs locally#

There are just few steps that you need to follow to run docs locally:

1. Fork the repo
2. Clone the repo
3. Create a python virtual environment and activate it
4. Install the dependencies
5. Type mkdocs serve