Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.09 KB

File metadata and controls

29 lines (16 loc) · 1.09 KB

Contributing to Looqbox

First off all, thanks for taking time to contribute with us!!

Code of Conduct

Everyone participating in this project is governed by our code of conduct. By participating, you are expected to uphold this code.

How to contribute

Reporting Bugs

If you don't know markdown sintax or don't want to write the documentation but saw something that can be improved or is wrong, please feel confortable to open an issue in this repository.

Making changes

We use MkDocs ti build our documentation using simple Markdown sintax. To properly see how your changes affects our guide, install the following packages:

pip install mkdocs
pip install mkdocs-cinder

After that, clone our repository and inside the folder run mkdocs serve, open your broser and go to http://localhost:8000/. Whenever you change a file related to our pages and save, mkdocs will update the page you are seeing in your localhost.

Our guide is written inside docs folder, feel free to contribute or open an issue.

Thanks! ❤️