Update the default bundle from `charmcraft init`
Metadata
Current evaluation
Merged after reviewer approval and conflict resolution. Updates the charmcraft init default bundle with improved metadata examples, splits developer instructions to CONTRIBUTING.md, and clarifies README setup steps.
Suggested action: —
No scores available.
Issue body
Include examples of more relation possibilities in `metadata.yaml`, and avoid using hyphens for them in favor of underscores. Also add `display_name`
Split developer contributing instructions to a separate document so the published README doesn't have them.
Also, update the README for charmcraft itself so contributors don't have to read the source to find out why `python -m charmcraft` doesn't actually work when cloned from git
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after reviewer approval and conflict resolution. Updates the charmcraft init default bundle with improved metadata examples, splits developer instructions to CONTRIBUTING.md, and clarifies README setup steps. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after resolving conflicts and addressing docs feedback. Updates the default charmcraft init bundle with better metadata examples and moves developer instructions to CONTRIBUTING.md. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after resolving conflicts and addressing documentation feedback. Updates the charmcraft init template to use underscores for relation names, adds a display_name field, and splits developer instructions into CONTRIBUTING.md to keep the README minimal. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #91 First pass at 'charmcraft init' | charmcraft | merged | Merged the initial 'charmcraft init' implementation. Approved by two reviewers, the PR adds 1087 lines across 24 files to scaffold charms. README.md, additional options, and interactive prompts require future updates. | |
| #279 Produce a manifest when building charms and bundles. | charmcraft | merged | Merged changes adding manifest generation for charm and bundle builds. The update modifies 12 files with 246 additions and 143 deletions. Authored by maintainer facundobatista and merged without formal review or CI checks. | |
| #188 Small text cleanups for README and charmcraft help | charmcraft | merged | Merged text cleanups for the README and charmcraft help documentation. Approved by two reviewers, the change updates 13 files to improve clarity while preserving test compatibility. | |
| #242 Add init documentation for a gentle introduction to the charm operator | charmcraft | merged | Merged PR adding starter docs to charmcraft init. Reviewer requested moving content to a Charmhub discourse wiki and linking it. Contributor adapted the change, and the PR was merged with the external link integrated. | |
| #1149 command: charmcraft init to use charmcraft.yaml only | charmcraft | merged | Merged after review. Updated charmcraft init to use a unified charmcraft.yaml by default, replacing separate metadata, actions, and config files. Added profile descriptions and updated URLs. Initially blocked but eventually merged. | |
| #2300 docs: update "manage configurations" | charmcraft | merged | Merged after two reviewers approved. Updated Charmcraft documentation links and renamed the section to Manage the app configuration per feedback. All CI checks passed and changes were integrated. | |
| #283 Smoother and safer template project from init command. | charmcraft | merged | Merged updates to charmcraft init that prevent publishing charms with leftover TEMPLATE-TODO markers. Validation was moved from build to upload per reviewer feedback. Fixes #237, #238, #243, and #247. | |
| #1195 ci: use charm and bundle names with the new auth | charmcraft | merged | Merged after approval. Updated CI configuration to align charm and bundle names with the new authentication system. Changes modified a single file (+2/-2 lines) with zero unresolved review comments. | |
| #471 config: add charm part to documentation (CRAFT-356) | charmcraft | merged | Merged changes adding charm configuration documentation to the configuration schema. Approved by two reviewers with zero unresolved comments. Updated two files with 15 additions and one deletion. Resolves CRAFT-356. | |
| #415 init command: populate default charmcraft.yaml (CRAFT-330) | charmcraft | merged | Merged. Adds default charmcraft.yaml generation to the init command, setting type charm and Ubuntu 20.04 bases. Approved by two reviewers and merged after PR #414 enabled integration tests. |