Skip to content

CONTRIBUTING#

Something is not clear or incorrenct or incomplete, something needs some updates over time or you found something new and cool that absolutely needs to be shared with the others... please contribute to this docs!!!

Submit an issue (no git/github skills required)#

Open an issue from here and try to be the most detailed possible.

Make the changes your self (minor git/github skills required)#

The actual text/scripts you find in this website are in this repo and in the doc folder here

Each article/section of the website is a specific markdown file with the same transparent name (more or less).

Edit from github#

Just find the the markdown file you want to edit (eg the one for this section contributing.md) and click on edit (the pen icon) on the top right.

When done, click on commit changes (green botton on the top right) and select Create a new branch for this commit and start a pull request and then Commit changes.

On the new opened page you can edit the title of the pull request to provide a more meaningful one, select a reviewer (highly reccomended!!!) and then finally create the pull request (PR).

If you fill confident you can then merge it right away or ask someone else to review the PR and then approve it with or without corrections and merge it.

To change the website strucute (change name to section, add sections or reorder them), see the file mkdocs.yml section Pages.

That's it!

Edit locally#

  1. fork this repository
  2. clone your forked repository
  3. install the dependencies via:
pip install -r requirements.txt
  1. create a branch
  2. make your changes in the respective markdown file in the doc folder
  3. visualize your changes by deploying a website preview via:
mkdocs serve

and view the preview here http://127.0.0.1:8000/welcome

  1. push your changes to your forked repository
  2. open a pull request