From a3f8310ab0ff663adfccbfc6c649e768b9cb06cb Mon Sep 17 00:00:00 2001 From: erinecon Date: Thu, 26 Mar 2026 11:50:46 -0400 Subject: [PATCH] chore(docs): update contributing guidelines (charmkeeper) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --- .github/pull_request_template.md | 61 ++++++------ CONTRIBUTING.md | 154 +++++++++++++++++++++++++------ docs/changelog.md | 9 ++ 3 files changed, 164 insertions(+), 60 deletions(-) create mode 100644 docs/changelog.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1d413c0..ccc1e4d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,36 +1,29 @@ - - - -### Overview - - - -### Rationale - - - -### Juju events changes - - - -### Module changes - - - -### Library changes - - - -### Checklist - -- [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied -- [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied -- [ ] The changes are compliant with [ISD054 - Manging Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619) -- [ ] The documentation for charmhub is updated. -- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`) - - diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 306a619..63c627b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,22 +4,103 @@ This document explains the processes and practices recommended for contributing ## Overview -- Generally, before developing enhancements to this charm, you should consider [opening an issue](https://github.com/canonical/pollen-operator/issues) explaining your use case. +- Generally, before developing enhancements to this charm, you should consider [opening an issue + ](https://github.com/canonical/pollen-operator/issues) explaining your use case. - If you would like to chat with us about your use-cases or proposed implementation, you can reach - us at the [Canonical Matrix public channel](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) + us at [Canonical Matrix public channel](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) or [Discourse](https://discourse.charmhub.io/). -- Familiarizing yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) library +- Familiarizing yourself with the [Juju documentation](https://documentation.ubuntu.com/juju/3.6/howto/manage-charms/) 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 operators of this charm. -- Please help us out in ensuring easy to review branches by re-basing your pull request branch onto the `main` branch. This also avoids merge commits and creates a linear Git commit history. -- Please generate `src` documentation for every commit. See the section below for more details. +- Once your pull request is approved, we squash and merge your pull request branch onto + the `main` branch. This creates a linear Git commit history. +- For further information on contributing, please refer to our + [Contributing Guide](https://github.com/canonical/is-charms-contributing-guide). -## Developing +## Code of conduct -To make contributions to this charm, you'll need a working [development setup](https://documentation.ubuntu.com/juju/3.6/howto/manage-your-deployment/). +When contributing, you must abide by the +[Ubuntu Code of Conduct](https://ubuntu.com/community/ethos/code-of-conduct). + +## Changelog + +Please ensure that any new feature, fix, or significant change is documented by +adding an entry to the [CHANGELOG.md](docs/changelog.md) file. Use the date of the +contribution as the header for new entries. + +To learn more about changelog best practices, visit [Keep a Changelog](https://keepachangelog.com/). + +## Submissions + +If you want to address an issue or a bug in this project, +notify in advance the people involved to avoid confusion; +also, reference the issue or bug number when you submit the changes. + +- [Fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) + our [GitHub repository](https://github.com/canonical/pollen-operator) + and add the changes to your fork, properly structuring your commits, + providing detailed commit messages and signing your commits. +- Make sure the updated project builds and runs without warnings or errors; + this includes linting, documentation, code and tests. +- Submit the changes as a + [pull request (PR)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork). + +Your changes will be reviewed in due time; if approved, they will be eventually merged. + +### AI + +You are free to use any tools you want while preparing your contribution, including +AI, provided that you do so lawfully and ethically. + +Avoid using AI to complete issues tagged with the "good first issues" label. The +purpose of these issues is to provide newcomers with opportunities to contribute +to our projects and gain coding skills. Using AI to complete these tasks +undermines their purpose. + +We have created instructions and tools that you can provide AI while preparing your contribution: [`copilot-collections`](https://github.com/canonical/copilot-collections) + +While it isn't necessary to use `copilot-collections` while preparing your +contribution, these files contain details about our quality standards and +practices that will help the AI avoid common pitfalls when interacting with +our projects. By using these tools, you can avoid longer review times and nitpicks. + +If you choose to use AI, please disclose this information to us by indicating +AI usage in the PR description (for instance, marking the checklist item about +AI usage). You don't need to go into explicit details about how and where you used AI. + +Avoid submitting contributions that you don't fully understand. +You are responsible for the entire contribution, including the AI-assisted portions. +You must be willing to engage in discussion and respond to any questions, comments, +or suggestions we may have. + +### Signing commits + +To improve contribution tracking, +we use the [Canonical contributor license agreement](https://assets.ubuntu.com/v1/ff2478d1-Canonical-HA-CLA-ANY-I_v1.2.pdf) +(CLA) as a legal sign-off, and we require all commits to have verified signatures. + +#### Canonical contributor agreement + +Canonical welcomes contributions to the Pollen Operator. Please check out our +[contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution. + +The CLA sign-off is simple line at the +end of the commit message certifying that you wrote it +or have the right to commit it as an open-source contribution. + +#### Verified signatures on commits + +All commits in a pull request must have cryptographic (verified) signatures. +To add signatures on your commits, follow the +[GitHub documentation](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). + +## Develop + +To make contributions to this charm, you'll need a working +[development setup](https://documentation.ubuntu.com/juju/latest/howto/manage-your-juju-deployment/set-up-your-juju-deployment-local-testing-and-development/). The code for this charm can be downloaded as follows: @@ -27,39 +108,61 @@ The code for this charm can be downloaded as follows: git clone https://github.com/canonical/pollen-operator ``` -Make sure to install [uv](https://docs.astral.sh/uv/), for example: +Make sure to install [`uv`](https://docs.astral.sh/uv/). For example, you can install `uv` on Ubuntu using: -```sh +```bash sudo snap install astral-uv --classic ``` -Then install `tox` with extensions, as well as a range of Python versions: +For other systems, follow the [`uv` installation guide](https://docs.astral.sh/uv/getting-started/installation/). -```sh +Then install `tox` with its extensions, and install a range of Python versions: + +```bash +uv python install uv tool install tox --with tox-uv uv tool update-shell ``` -To create an environment for development, use: +To create a development environment, run: -```shell +```bash uv sync --all-groups -source venv/bin/activate +source .venv/bin/activate ``` -### Testing +### Test This project uses `tox` for managing test environments. There are some pre-configured environments that can be used for linting and formatting code when you're preparing contributions to the charm: -- `tox 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 'format', 'lint', and 'unit' environments. +* ``tox``: Executes all of the basic checks and tests (``lint``, ``unit``, ``static``, and ``coverage-report``). +* ``tox -e fmt``: Runs formatting using ``ruff``. +* ``tox -e lint``: Runs a range of static code analysis to check the code. +* ``tox -e static``: Runs other checks such as ``bandit`` for security issues. +* ``tox -e unit``: Runs the unit tests. +* ``tox -e integration``: Runs the integration tests. +### Build the rock and charm -## Build charm +Use [Rockcraft](https://documentation.ubuntu.com/rockcraft/stable/) to create an +OCI image for the Pollen app, and then upload the image to a MicroK8s registry, +which stores OCI archives so they can be downloaded and deployed. + +Enable the MicroK8s registry: + +```bash +microk8s enable registry +``` + +The following commands pack the OCI image and push it into +the MicroK8s registry: + +```bash +cd +rockcraft pack +skopeo --insecure-policy copy --dest-tls-verify=false oci-archive:.rock docker://localhost:32000/:latest +``` Build the charm in this git repository using: @@ -71,13 +174,12 @@ charmcraft pack ```bash # Create a model -juju add-model pollen-dev +juju add-model charm-dev # Enable DEBUG logging juju model-config logging-config="=INFO;unit=DEBUG" -# Deploy the charm (assuming you're on amd64) -juju deploy ./pollen_ubuntu-22.04-amd64.charm +# Deploy the charm +juju deploy ./pollen*.charm ``` -## Canonical contributor agreement -Canonical welcomes contributions to the Pollen Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution. + diff --git a/docs/changelog.md b/docs/changelog.md new file mode 100644 index 0000000..cb1aa1b --- /dev/null +++ b/docs/changelog.md @@ -0,0 +1,9 @@ +(changelog)= + +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). + +Each revision is versioned by the date of the revision.