← Back to issue list

docs: update README according to template

View original Github issue

Metadata

Project
craft-parts
Number
#1199
Type
pull request
State
merged
Author
bepri
Labels
—
Created
Updated
Closed

Current evaluation

README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff.

Resolution: closed resolved

Reason: PR #1199 was merged into the project’s main branch, resolving the documentation update. The merge is recorded by commit ef4d4fff, and all CI checks passed.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you added an entry to the changelog (`docs/reference/changelog.rst`)? ----- Updates README according to the template with strong influence from [Craft Application's](https://github.com/canonical/craft-application/blob/259acbadcf291f3bf47e3e3dfc2d3cebdb1121ef/README.md) current README.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved README documentation was updated to match the standard template; PR #1199 was merged via commit ef4d4fff.
stealth/space-bunny-alpha — closed resolved Merged canonical/craft-parts#1199, updating the README to follow the standard template with strong inspiration from Craft Application’s README.
qwen/qwen3.6-35b-a3b — — Merged after two approvals and passing CI. Updates the README to align with a standard template, heavily inspired by Craft Application, modifying one file with 40 additions and 11 deletions.
qwen3.6-35b-a3b-mtp-q6 — — Merged a maintainer request updating the README to align with a standard template, heavily influenced by the Craft Application project. Accepted without review comments.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#258 docs: update readme and template, fix build error starbase merged Merged PR #258 in commit 7d2790e, improving README and docs-preparation guidance and disabling PDF/EPUB generation to restore the documentation build.
79%
#387 docs: add readme template starbase merged Merged PR #387 added a README template, landing as commit afc6663 after two approvals and with all listed CI checks passing.
78%
#31 docs: update main page with the standard template craft-archives merged Merged PR #31 updated the main documentation page to the standard template; the change landed in commit bde6712.
76%
#370 docs: update `CONTRIBUTING.md` craft-cli merged Merged PR #370 (commit b7a0dbb), aligning CONTRIBUTING.md with the project template and incorporating review wording changes.
75%
#1052 docs: Update README.md contributing link rockcraft merged Merged PR #1052 (commit 509abf1a) fixed the broken contributing link in README.md, pointing it to CONTRIBUTING.md instead of the stale URL. Docs-only, +1/-1 lines; approved by 3 reviewers.
75%
#14 update README.md to be more introductory charmcraft merged Docs-only PR #14 merged via commit fa446930 (merge df14ae5c) from chipaca, rewriting README.md (+42/-1) to be more introductory.
74%
#368 docs: update CONTRIBUTING.md craft-cli merged Merged PR #368 (commit e75f8ef) updated CONTRIBUTING.md to align with the project template, +107/-55 lines in one file; all CI checks passed.
74%
#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%
#23 readme: update name starbase merged Merged PR #23 as commit 9c1ea2a, updating three project-name references in the README; approved by one reviewer with no unresolved comments.
74%
#286 Update README.md charmcraft merged Docs-only PR by pedroleaoc merged into master via 7ef3261b (head commit efee51ca): refreshed README.md terminology, +13/-13 lines, approved by 3 reviewers with no unresolved comments.
73%