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 of ``build``, ``ci``, ``docs``, ``feat``, ``fix``, ``perf``, ``refactor``, ``test``. - Use lowercase. - Code style is enforced by `pre-commit hooks `_ locally and by the **Lint** CI workflow on every push and PR. Hooks run: trailing-whitespace remover, end-of-file fixer, `black `_ (v24.2.0), and `ruff `_ linter. Setup once with:: pip install pre-commit pre-commit install Run manually on all files with ``pre-commit run --all-files``. Building Documentation ---------------------- To build and view the documentation locally: .. code-block:: bash # 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. .. raw:: html