How to contribute
This document explains the processes and practices recommended for contributing enhancements to the SAML Integrator 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 Canonical Mattermost 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 administrators of this charm.
- Please generate src documentation for every commit. See the section below for more details. For more details, check our contributing guide.
Developing
For any problems with this charm, please report bugs here.
The code for this charm can be downloaded as follows:
git clone https://github.com/canonical/saml-integrator-operator
To run tests, run tox from within the charm code directory.
To build and deploy a local version of the charm, simply run:
charmcraft pack
# Ensure you're connected to a juju model, assuming you're on amd64
juju deploy ./saml-integrator_ubuntu-20.04-amd64.charm
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
Canonical contributor agreement
Canonical welcomes contributions to the SAML Integrator Operator. Please check out our contributor agreement if you’re interested in contributing to the solution.