Contributing

Thank you for your interest in getting involved! We welcome all skill levels and abilities as contributions. Visit our Traffic Monitor GitHub page to get involved.

Contributions can include any of the following plus more!

• 💡 Feature requests and use case ideas
• 🐞 Bug reports
• 👩‍💻 Code contributions, see Contributing
• 👍 Comment on or thumbs-up milestones or issues
• 💬 Questions, comments, and videos/images of your deployments on our Traffic Monitor Zulip Chat!

We foster a safe and welcoming community, review our Code of Conduct.

Writing docs

These docs are Markdown files in the repo's docs/ folder, built with Material for MkDocs. Docs changes go in the same pull request as the code they describe, against dev.

• Preview while you edit: from the repo root, run python3 -m venv ~/.venvs/tm-docs && ~/.venvs/tm-docs/bin/pip install --require-hashes -r docs-site/requirements.txt once, then ~/.venvs/tm-docs/bin/mkdocs serve and open http://127.0.0.1:8000.
• Check before you push: mkdocs build --strict fails on broken links, anchors, and images, and on pages missing from the nav. Pull requests run the same check.
• New pages go in the nav: list in mkdocs.yml.
• Images go in docs/assets/images/. Link them with Markdown, ![Alt text](../assets/images/name.png), so the build can check the path. Add a caption with <figure markdown="span"> (see existing pages).
• Callouts use admonitions: !!! info, !!! success, !!! warning, or !!! danger, followed by the text indented four spaces.

Versions: pushes to dev publish to /dev/, and each release tag (vX.Y.Z) publishes a frozen copy and becomes /latest/, the default version.