← 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

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.

Suggested action: close stale

Reason: The issue is inactive for ~13 months (last activity was an autogenerated Jira-sync bot comment on 2024-09-28) and the underlying work appears complete: its dependency canonical/starbase#233 is closed, the sibling rockcraft#668 was closed as fixed via PR #881, and charmcraft's README was aligned with the model in commit 12308dde (PR #2283) with the current README matching the standard craft template structure. No further action is pending on this issue.

Impact: 20 Quick Win: 14.0 Staleness: 75 Complexity: 30 Confidence: 65 Support Request: 0

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
qwen/qwen3.8-27b
Impact: 20
Quick Win: 14.0
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.
qwen3.6-35b-a3b-mtp-q6
Staleness: 90
Complexity: 10
Confidence: 80
Support Request: 0
close stale Harmonize craft project READMEs with a new template to improve contributor documentation. Currently blocked pending canonical/starbase#233. Internal Jira ticket created. Issue remains inactive after 304 days.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/starbase#233 (confidence 90%)

    Explicit dependency in the issue body ('Depends on canonical/starbase#233'); that issue is closed, resolved via starbase PR #387.

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

    Sibling issue with identical title in rockcraft, closed as resolved via rockcraft PR #881, indicating the cross-project harmonization effort concluded.

  • Likely Fixed By: charmcraft#2283 (confidence 70%)

    Commit 12308dde 'docs: align README with model (#2283)' matches the issue's goal; current README follows the standard craft template layout.

Related issues

Issue Project State Summary Similarity
#668 Docs: Harmonize README with template rockcraft closed README updated to match the canonical/starbase template. Issue closed after resolution via pull request #881, which implemented the standardized documentation structure.
83%
#233 Docs: Add README template starbase closed Resolved by merging PR #387 in canonical/starbase. A standardized Markdown README template for craft projects was implemented, covering installation, build steps, and licensing requirements.
79%
#4957 Docs: Harmonize README with template snapcraft closed Closed without implementation. The README harmonization request was abandoned after an internal Jira ticket was created. No code changes or merges occurred.
74%
#2283 docs: align README with model charmcraft merged Merged after approval. The update aligned the project README with the official template and resolved local build errors caused by unused Craft Parts documentation. Two files were modified, resulting in 79 additions and 49 deletions.
70%