This document explains the processes and practices recommended for contributing enhancements to this operator.
- Generally, before developing bugs or enhancements to this charm, you should open an issue explaining your use case.
- If you would like to chat with us about charm development, you can reach us at Canonical Matrix public channel or 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 of 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.
You can use the environments created by tox
for development. It helps
install pre-commit
, mypy
type checker, linting tools, and formatting tools.
tox -e dev
source .tox/dev/bin/activate
tox -e unit # unit tests
tox -e integration # integration tests
Build the charm in this git repository using:
charmcraft pack
# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./oathkeeper*.charm --resource oci-image=$(yq eval '.resources.oci-image.upstream-source' charmcraft.yaml)
Canonical welcomes contributions to Charmed Ory Oathkeeper. Please check out our contributor agreement if you're interested in contributing to the solution.