Skip to content

Latest commit

 

History

History
80 lines (63 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

80 lines (63 loc) · 2.32 KB
Raw

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 Canonical Mattermost 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 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

Install tox, poetry, and charmcraftcache

Install pipx: https://pipx.pypa.io/stable/installation/

pipx install tox
pipx install poetry
pipx install charmcraftcache

You can create an environment for development:

poetry install

Testing

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

Build charm

Build the charm in this git repository using:

tox run -e build-dev

Deploy

# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
# `--trust` needed if Role Based Access Control (RBAC) (https://kubernetes.io/docs/concepts/security/rbac-good-practices/) is enabled on Kubernetes

juju deploy ./*.charm \
    --resource ghcr.io/canonical/<TODO> --trust

Canonical Contributor Agreement

Canonical welcomes contributions to the Charmed TODO Operator. Please check out our contributor agreement if you're interested in contributing to the solution.