How to contribute

Charmed MySQL K8s is an open-source project that warmly welcomes community contributions, suggestions, fixes and constructive feedback.

This page explains the processes and practices recommended for contributing to this charm’s code and documentation.

Submit a bug or issue

  • Report software issues or feature requests through GitHub

  • Report security issues through Launchpad

Contribute to the code

Before developing new features or fixes to this charm, you consider opening an issue on GitHub explaining your use case.

If you would like to chat with us about your use-cases or proposed implementation, you can reach us at our Data Platform Matrix channel.

Tips for a good contribution

  • Familiarize yourself with the Charmed Operator Framework library.

  • All contributions require review before being merged. Code review typically examines

    • Code quality

    • Test coverage

    • User experience for Juju operators of this charm

Contribute to the documentation

We strongly rely on community feedback to improve our documentation, and would love to hear from you.

There are a few ways to do this: