chore(docs): update contributing guidelines (charmkeeper)#75
Open
chore(docs): update contributing guidelines (charmkeeper)#75
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
erinecon
added
documentation
florentianayuwono
approved these changes
Mar 27, 2026
Comment on lines
+148
to
+166
| Use [Rockcraft](https://documentation.ubuntu.com/rockcraft/stable/) to create an | ||
| OCI image for aproxy, 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 <project_dir> | ||
| rockcraft pack | ||
| skopeo --insecure-policy copy --dest-tls-verify=false oci-archive:<rock-name>.rock docker://localhost:32000/<app-name>:latest | ||
| ``` | ||
|
|
Collaborator
There was a problem hiding this comment.
Contributor
Author
There was a problem hiding this comment.
Ahhh well if there's no rock for this repo, then this part of CONTRIBUTING.md can be removed. (Once we move to a modularized approach for our contributing guides, this will be less of a hassle.)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR updates the contributing guidelines for the aproxy charm.
Now the CONTRIBUTING.md file contains an AI usage contributing policy, and the PR description template contains a new checklist item for indicate AI usage. These templates were taken from the platform-engineering-charm-template repository.
docs/how-to/contribute.mdwill not be updated until we create the RTD site for this project.Changes
CONTRIBUTING.md.github/pull_request_template.yaml.github/pull_request_template.mdThis PR was automatically created by charmkeeper.