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 public Canonical Data Platform 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 of this charm.
- Please help us out in ensuring easy to review branches by rebasing your pull request branch onto
the
mainbranch. This also avoids merge commits and creates a linear Git commit history.
Install tox, poetry, and charmcraftcache
Install pipx: https://pipx.pypa.io/stable/installation/
pipx install tox
pipx install poetry
pipx install charmcraftcacheYou can create an environment for development:
poetry installtox 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' environmentsBuild the charm in this git repository using:
tox run -e build-dev# Create a model
juju add-model dev
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./mysql_ubuntu-22.04-amd64.charmCanonical welcomes contributions to the MySQL Operator. Please check out our contributor agreementif you're interested in contributing to the solution.