Contributing¶
Contributing Guidelines¶
Follow Angular’s commit message convention for PRs. - This applies to PR’s title and ultimately the commit messages in
main. - The prefix shall be one ofbuild,ci,docs,feat,fix,perf,refactor,test. - Use lowercase.Format your code with black. This will be enforced by the CI.
Building Documentation¶
To build and view the documentation locally:
# Build the documentation
cd docs
make html
# Start a local server to view the documentation
python -m http.server 8000 --directory _build/html
Then open your browser and navigate to http://localhost:8000 to view the documentation.
Build with CamTools¶
If you use CamTools in your project, consider adding one of the following badges to your project.
