← Back to issue list

Docs: Harmonize README with template

View original Github issue

Metadata

Project
charmcraft
Number
#1929
Type
issue
State
open
Author
medubelko
Labels
—
Created
Updated
Closed
—

Current evaluation

README harmonization with Starbase template. Blocking dependency starbase#233 closed; PR #2283 aligned README with the model. Work appears complete but issue remains open.

Suggested action: close resolved

Reason: PR #2283 ('docs: align README with model') merged and aligned Charmcraft's README with the Starbase model, and the blocking dependency canonical/starbase#233 is closed with the template added via PR #387. The current README follows the template structure (installation, usage, documentation, contribution, license), and the equivalent rockcraft issue #668 was closed as resolved via PR #881.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 14 Complexity: 20 Confidence: 70 Actionability: 70

Issue body

### What needs to get done We must harmonize the READMEs of all craft projects. The template will be provided by https://github.com/canonical/starbase/issues/233. We can leave the build section as a WIP while that process is being improved. Depends on https://github.com/canonical/starbase/issues/233. ### Why it needs to get done Improves contributor documentation.

Evaluation history

Date Model Scores Action Summary
~deepseek/deepseek-pro-latest
Impact: 25
Quick Win: 14
Complexity: 20
Confidence: 70
Actionability: 70
close resolved README harmonization with Starbase template. Blocking dependency starbase#233 closed; PR #2283 aligned README with the model. Work appears complete but issue remains open.
qwen/qwen3.6-35b-a3b
Impact: 20
Quick Win: 11
Complexity: 10
Confidence: 70
Actionability: 60
needs triage Harmonize charmcraft README with the standardized template from starbase#233. Depends on resolved template issue; similar tasks completed in rockcraft#881 and closed in snapcraft#4957.
qwen/qwen3.8-27b
Impact: 20
Quick Win: 14
Staleness: 75
Complexity: 30
Confidence: 65
Support Request: 0
close stale Task to harmonize craft project READMEs with the starbase template. Dependency starbase#233 is closed, and charmcraft's README was aligned with the model in PR #2283, but the issue remains open with no maintainer activity since 2024-09.
qwen/qwen3.6-35b-a3b
Staleness: 90
Complexity: 10
Confidence: 85
Support Request: 0
close stale Task to update project READMEs to match a canonical template, currently blocked by an external dependency and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 15
Confidence: 75
Support Request: 0
close stale Task to update project READMEs to match a canonical template, currently blocked by an external dependency and inactive for over a year.
qwen3.6-35b-a3b-mtp-q6
Staleness: 85
Complexity: 10
Confidence: 75
Support Request: 5
needs triage Unlabelled documentation task to harmonize READMEs using an external template. No maintainer response or labels after over a year of inactivity, pending external dependency resolution.

Update history

No update history recorded yet.

Related work

  • Blocked By: canonical/starbase#233 (confidence 100%)

    Issue body explicitly states it depends on starbase#233, which is now closed with the template added.

  • Related To: canonical/rockcraft#668 (confidence 100%)

    Same harmonization issue in rockcraft, closed as resolved via PR #881.

  • Related To: canonical/snapcraft#4957 (confidence 100%)

    Same harmonization issue in snapcraft, closed as abandoned without implementation.

  • Likely Fixed By: canonical/charmcraft#2283 (confidence 75%)

    PR titled 'docs: align README with model' merged and aligned the README with the Starbase model, matching this issue's goal.

Related issues

Issue Project State Summary Similarity
#2283 docs: align README with model charmcraft merged Docs-only PR merged as commit 12308dde ("docs: align README with model (#2283)"): rewrote README to match canonical/starbase README template and dropped unused Craft Parts docs, fixing local build errors. 2 files, +79/-49.
76%
#397 docs: rearrange READMEs starbase merged Merged docs-only PR moving Starbase's rendered README into .github/README.md and the generic template to the root README.md, clarifying the future update workflow. All CI checks passed.
74%
#4957 Docs: Harmonize README with template snapcraft closed README was harmonized with the Craft model in commit f4d43dcdb (docs: align readme with model), fulfilling the requested documentation cleanup before closure.
74%
#93 README.rst template starbase closed Added a reusable README template and related documentation updates in canonical/starbase#387 (commit afc6663).
73%
#785 fix: remove Starbase README craft-application merged PR #785 merged as commit d6b706a3, deleting the 144-line Starbase-rendered .github/README.md from craft-application. Approved by 2 reviewers; lint/tests/builds passed (OSV-scanner failed, non-blocking).
73%
#140 docs: use the Starbase README template craft-platforms merged Merged PR #140 adopted the Starbase README template, adding GitHub badges requested in #89; landed as commit 376010f with all CI checks passing.
73%
#336 docs: fix some formatting errors in README starbase merged Docs-only PR merged as commit d3d4189, adding 10 lines to starbase's README to fix spacing/formatting errors that slipped past the earlier README cleanup in #331 (commit de0d308). Approved by 2 reviewers, no CI.
72%
#233 Docs: Add README template starbase closed Added the Craft project README template in merged PR canonical/starbase#387 (commit afc6663), covering Markdown setup, installation, builds, licensing, and contribution links.
72%