Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 3.99 KB

CONTRIBUTING.md

File metadata and controls

110 lines (80 loc) · 3.99 KB
Raw

Contributing

Overview

This document explains the processes and practices recommended for contributing enhancements to the charm.

  • Generally, before developing enhancements to this charm, you should consider [opening an issue ](link to issues page) 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 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 operators 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.
  • Please generate src documentation for every commit. See the section below for more details.

Developing

To make contributions to this charm, you'll need a working development setup.

The code for this charm can be downloaded as follows:

git clone https://github.com/canonical/<charm-name>

You can use the environments created by tox for development:

tox --notest -e unit
source .tox/unit/bin/activate

Testing

This project uses tox for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm:

  • tox: Runs all of the basic checks (lint, unit, static, and coverage-report).
  • tox -e fmt: Runs formatting using black and isort.
  • tox -e lint: Runs a range of static code analysis to check the code.
  • tox -e static: Runs other checks such as bandit for security issues.
  • tox -e unit: Runs the unit tests.
  • tox -e integration: Runs the integration tests.

Generating src docs for every commit

Run the following command:

echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

Building the charm

Build the charm in this git repository using:

charmcraft pack

Deploying

# Create a model
juju add-model charm-dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm (assuming you're on amd64)
juju deploy ./<charm-name>.charm

Canonical Contributor Agreement

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