← Back to issue list

docs: Guidance on charm naming best practices could be clearer

View original Github issue

Metadata

Project
charmcraft
Number
#2582
Type
issue
State
open
Author
YanisaHS
Labels
Created
2026-03-06 15:11:12+00:00
Updated
2026-03-09 03:02:02+00:00
Closed

Current evaluation

Documentation on charm naming conventions requires clarification, and the issue is under discussion with a contributor ready to implement updates as part of related roadmap work.

Suggested action: keep open

Reason: The issue has been acknowledged by maintainers, and one has explicitly volunteered to address the documentation improvements as part of their roadmap work. It is a valid, actionable request that should remain open until the changes are implemented.

Staleness: 45 Complexity: 15 Confidence: 90 Support Request: 0

Issue body

### Check existing issues - [x] I've verified that this request isn't described by any existing issues. ### Request **Relevant links:** 1. https://documentation.ubuntu.com/charmcraft/latest/reference/files/charmcraft-yaml-file/#charmcraft-yaml-key-name 1. https://documentation.ubuntu.com/charmcraft/latest/howto/manage-charms/#initialise-a-charm 1. https://documentation.ubuntu.com/charmcraft/latest/howto/manage-charms/#specify-a-name Just my opinion, but it's easy to look at these pages and see them as unclear and even having conflicting information at first pass A "quick fix" could be in the "best practices" section on the charmcraft.yaml doc could change to something like: "Don’t add an operator or charm prefix or suffix in your `charmcraft.yaml` file. For charm repository naming conventions, see [Initialise a charm](https://documentation.ubuntu.com/charmcraft/latest/howto/manage-charms/#initialise-a-charm)." (although I'm far from a charm expert - so keep that perspective in mind :)) But in general, it might be helpful to have something more explicit about the naming standards for charms - what the charm itself should be named, and what the git repository should be named, what shows up in Charmhub, etc. The experience I had which led me to opening this issue was that I wanted to find the naming conventions for a new charm repository in GitHub, so I Googled something like "charmcraft docs new charm name standards" and got doc 1, which points to doc 2, which points to doc 3, which points back to doc 1. I cycled a bit through them before realizing the charm name and charm repository name are explicitly supposed to be different ### Document location https://documentation.ubuntu.com/charmcraft/latest/reference/files/charmcraft-yaml-file/#charmcraft-yaml-key-name

Evaluation history

Date Model Scores Action Summary
2026-06-15 12:26:18.484522+00:00 qwen3.6-35b-a3b-mtp-q6
Staleness: 45
Complexity: 15
Confidence: 90
Support Request: 0
keep open Documentation on charm naming conventions requires clarification, and the issue is under discussion with a contributor ready to implement updates as part of related roadmap work.
2026-06-15 12:24:08.799929+00:00 pending