← Back to issue list

Docs: Harmonize README with template

View original Github issue

Metadata

Project
snapcraft
Number
#4957
Type
issue
State
closed
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

README was harmonized with the Craft model in commit f4d43dcdb (docs: align readme with model), fulfilling the requested documentation cleanup before closure.

Resolution: closed resolved

Reason: Commit f4d43dcdb is recorded in README.md history and directly implements the requested template alignment. No linked resolving PR or maintainer explanation was recorded.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done The README is incomplete, and we should be harmonizing all of them across craft projects. For now, we can rewrite it using the template in https://github.com/canonical/starbase/issues/233, and leave the build section blank while @sergiusens polishes it. 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
stealth/space-bunny-alpha — closed resolved README was harmonized with the Craft model in commit f4d43dcdb (docs: align readme with model), fulfilling the requested documentation cleanup before closure.
stealth/space-bunny-alpha — closed stale README harmonization was closed without implementation; no resolving PR or commit was recorded, and the only follow-up was creation of internal ticket CRAFT-3196.
stealth/space-bunny-alpha — closed stale README harmonization was abandoned without implementation; the only recorded follow-up was automatic creation of internal Jira ticket CRAFT-3196.
qwen/qwen3.6-35b-a3b — — Closed without implementation. The README harmonization request was abandoned after an internal Jira ticket was created. No code changes or merges occurred.
qwen/qwen3.6-35b-a3b — — Request to harmonize the README with a template was closed. It depended on another issue and was likely superseded or abandoned, with an internal Jira ticket created for tracking.
qwen/qwen3.6-35b-a3b — — Closed without resolution. The README harmonization request was logged and synced to Jira, but no implementation, merge, or follow-up actions were recorded.
qwen3.6-35b-a3b-mtp-q6 — — Abandoned. The README harmonization task was closed without implementation, and no resolution or merge details were provided.

Update history

No update history recorded yet.

Related work

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

    The issue explicitly depended on the shared README template work in starbase#233.

Related issues

Issue Project State Summary Similarity
#668 Docs: Harmonize README with template rockcraft closed Rockcraft's README was harmonized with the Craft project template by merged PR canonical/rockcraft#881 (commit dc33814c, +90/-189). Maintainer medubelko closed #668 on 2025-09-13 citing that PR.
82%
#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.
79%
#881 docs: harmonize readme with template rockcraft merged Merged as dc33814c: harmonized Rockcraft's README with the project template (+90/-189, 3 files); reviewer flagged linting, fixed via make autoformat, all CI checks green.
77%
#5348 docs: align readme with model snapcraft merged Merged PR canonical/snapcraft#5348 in commit f4d43dcdb, aligning the README with Snapcraft's project model and resolving #4957.
74%
#136 docs: consistentize the READMEs craft-actions open Documentation PR making README files across craft-actions consistent. Under review with 5 unresolved comments, CI passing.
74%
#1929 Docs: Harmonize README with template charmcraft open README harmonization with Starbase template. Blocking dependency starbase#233 closed; PR #2283 aligned README with the model. Work appears complete but issue remains open.
74%
#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.
73%
#49 Improved README and docs on how to use the lib (CRAFT-707). craft-cli merged Merged in canonical/craft-cli#49 via d5f6567, improving the README and library usage documentation for CRAFT-707 across seven files.
73%
#1197 docs: align `CONTRIBUTING.md` with template craft-parts merged Merged docs-only PR #1197 (commit 41cbe718) aligning CONTRIBUTING.md with the craft project template, +147/-89 lines; follow-up to earlier CONTRIBUTING work in #1134/#1142.
72%
#443 docs: adopt standard README model imagecraft closed Merged as commit 59f3e49 "docs: adopt standard README model (#443)" by maintainer jahn-junior, rewriting README.md (+27/-25) with standard product usage/installation copy; all CI checks passed.
70%