Skip to content

Latest commit

 

History

History
64 lines (47 loc) · 1.9 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 1.9 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.
  • 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.

Developing

You can create an environment for development with tox:

tox devenv -e integration-juju3
source venv/bin/activate

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-juju2   # integration tests for juju 2.9
tox run -e integration-juju3   # integration tests for juju 3.2
tox                            # runs 'lint' and 'unit' environments

Build charm

Build the charm in this git repository using:

charmcraft pack

Deploy

# Create a model
juju add-model dev

# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"

# Deploy the charm
juju deploy ./lxd-integrator_ubuntu-22.04-amd64.charm

Canonical Contributor Agreement

Canonical welcomes contributions to the LXD Integrator Charm. Please check out our contributor agreement if you're interested in contributing to the solution.