CONTRIBUTING.md

Contributing to observability-libs

Bugs and pull requests

• Generally, before developing enhancements to this charm, you should consider 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.
• All enhancements require review before being merged. Apart from code quality and test coverage, the review will also take into account the resulting user experience for Juju administrators using this charm.

Setup

A typical setup using snaps can be found in the Juju docs.

Developing

You can use the environments created by tox for development:

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

Testing

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

Build charm

Build the charm in this git repository using:

charmcraft pack