Our project welcomes external contributions. If you see somewhere were there is a bug please feel free to fix it! However, by design this project has a limited scope as a demonstration.
To contribute code or documentation, please submit a pull request.
This project has adopted the Contributor Covenant Code of Conduct, for the community surrounding this project.
This docs website leverages MkDocs, Material for MkDocs, along with a number of plugins to build the website. The github actions workflows will validate the markdown content:
- Markdown can be transformed successfully to HTML
- Does not contain any invalid links or missing images
Contributors can validate locally using make docs-validate after installing dependencies with make install.
MkDocs is a python package. most dependencies are system independent and installable using make install or pip install -r requirements.txt.
However, the social previews require cairosvg, which depends on a number of system libraries. Instructions are provided by Material for MkDocs on installing those dependencies.
On MacOS - make osx-deps will use brew to install the dependencies, which relies on homebrew
On Ubuntu or debian: make ubuntu-deps with sufficient (sudo) rights.
Contributors to this project are expected to sign off on the Linux's foundations Developer Certificate of Origin, applied to this project.
DCOBot checks whether commits have been --signoff'ed. Contributors may as an alternative, Signoff in their pull request.
The project maintainers use LGTM (Looks Good To Me) in comments on the code review to indicate acceptance. A change requires LGTMs from one of the maintainers.