This documents explains the processes and practices recommended for contributing enhancements to the Keystone charm.
- 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. The primary author of this charm is available on
the Mattermost channel as
@davigar15
. - 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.
You can use the environments created by tox
for development:
tox --notest -e unit
source .tox/unit/bin/activate
tox -e fmt # update your code according to linting rules
tox -e lint # code style
tox -e unit # unit tests
# tox -e integration # integration tests
tox # runs 'lint' and 'unit' environments
Build the charm in this git repository using:
charmcraft pack
# Create a model
juju add-model test-keystone
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./keystone_ubuntu-20.04-amd64.charm \
--resource keystone-image=opensourcemano/keystone:testing-daily