docs: add how-to guide for naming and initialising a charm#2449
Merged
dwilding merged 9 commits intocanonical:mainfrom Apr 29, 2026
Merged
docs: add how-to guide for naming and initialising a charm#2449dwilding merged 9 commits intocanonical:mainfrom
dwilding merged 9 commits intocanonical:mainfrom
Conversation
dwilding
commented
Apr 24, 2026
dwilding
commented
Apr 24, 2026
dwilding
commented
Apr 24, 2026
dwilding
commented
Apr 24, 2026
james-garner-canonical
approved these changes
Apr 29, 2026
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
3 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 adds a new how-to guide called "How to initialise your project". I'm doing this for two reasons:
Our current guidance is not so easy to find. This topic deserves to be discoverable from the Ops homepage and the list of how-to guides.
In the charming docs generally, it could be clearer how developers are supposed to name their repos and charms. See charmcraft#2582. I'm taking this opportunity to improve our naming guidelines.
Preview of new how-to guide
Also updated: