Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (28 loc) · 912 Bytes

CONTRIBUTING.md

File metadata and controls

41 lines (28 loc) · 912 Bytes

Contributing to Charmarr

Prerequisites

  • Python 3.12+
  • uv for dependency management
  • tox for running tests
  • charmcraft for Juju charms

Development

uv venv && source .venv/bin/activate
uv sync
tox -e fmt      # format
tox -e lint     # lint
tox -e static   # type check
tox -e unit     # test (80% coverage required)

Commits

Follow Conventional Commits:

<type>(scope): description

Types: feat, fix, docs, refactor, test, ci, chore

Pull Requests

  1. Fork and create a branch (feat/thing or fix/bug)
  2. Make changes, add tests, run tox
  3. Open PR with clear description and reference any related issues

All PRs require review and passing CI.

Code of Conduct

See CODE_OF_CONDUCT.md.