How to contribute

Overview

This document explains the processes and practices recommended for contributing enhancements to the GitHub Runner 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.
• Familiarizing 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. 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/github-runner-operator.git

Prior to working on the charm ensure juju is connected to an LXD cloud, see the upstream documentation for details.

To test the charm, unit test can be ran with tox -e unit and the integration test on juju 3.1 can be ran with tox -e integration-juju3.1.

Canonical Contributor Agreement

Canonical welcomes contributions to the GitHub Runner Operator. Please check out our contributor agreement if you’re interested in contributing to the solution.