Contributing

Overview

This documents explains the processes and practices recommended for contributing enhancements to this operator.

• Generally, before developing enhancements to this charm, you should consider opening an issue explaining your use case.
• If you would like to chat with us about your use-cases or proposed implementation, you can reach us at Discourse.
• Familiarising yourself with the Charmed Operator Framework library will help you a lot when working on new features or bug fixes.
• All enhancements require review before being merged. Code review typically examines
  • code quality
  • test coverage
  • user experience for Juju administrators this charm.
• Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the main branch. This also avoids merge commits and creates a linear Git commit history.

Developing

To set up a local development environment with all required dependencies, tools, and pre-commit configurations, you can use uv:

uv sync --group dev
source .venv/bin/activate

Testing

tox -e fmt           # update your code according to linting rules
tox -e lint          # code style
tox -e unit          # unit tests
tox -e integration   # integration tests
tox                  #runs 'fmt', 'lint', and 'unit' environments

Building

Build the charm using:

charmcraft pack

Deploying

# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./openfga-k8s_ubuntu-22.04-amd64.charm