Skip to content

Latest commit

 

History

History
45 lines (34 loc) · 2.03 KB

CONTRIBUTING.md

File metadata and controls

45 lines (34 loc) · 2.03 KB
Raw

How to contribute

Overview

This document explains the processes and practices recommended for contributing enhancements to the GitHub Actions Exporter.

  • 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 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.
  • For more details, please refer to 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-actions-exporter-operator

To run tests, simply 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 k8s model, assuming you're on amd64
juju deploy ./github-actions-exporter_ubuntu-22.04-amd64.charm

Canonical contributor agreement

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