← Back to issue list

Docs: Add README template

View original Github issue

Metadata

Project
starbase
Number
#233
Type
issue
State
closed
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Added the Craft project README template in merged PR canonical/starbase#387 (commit afc6663), covering Markdown setup, installation, builds, licensing, and contribution links.

Resolution: closed resolved

Reason: PR canonical/starbase#387 was merged with all CI checks passing and added the requested README template as commit afc6663.

Evaluated by: mr-cal-bot

No scores available.

Issue body

We should have a standard template that every craft project can use. After discussion with the doc team, the [Anbox template](https://github.com/canonical/anbox-cloud-templates/blob/main/templates/readme.md) is the closest we have to a standard template at the moment, and will be the basis for an official template later on. @mr-cal To speed this along, here's the same template but made generic for craft projects: <summary>Click to expand</summary> <details> <pre> &lt;img align="center" src="[link to logo]" alt="[Project name]"&gt; Insert a logo. The file should be hosted inside the repo. \# \<title\> Provide the title of the project, library, or tool, or otherwise what the repository delivers. Add the build status tags. Add a few succinct lines about what the project or code does and why it's useful. \#\# Installation Enter the install instructions. Include any prerequisites and needed configurations. \#\# Usage Enter the instructions or steps to use the tool/utility in its most basic case. \#\# Build Include the most build instructions. Include any prerequisites and needed configurations. \#\# Integrations (Optional) Include details about what's needed required with any other components. \#\# Security (Optional) Include instructions required to ensure security and also a means to report security vulnerabilities and issues. \#\# Cleanup (Optional) Include instructions on how to uninstall/remove and clean up. \#\# Licensing Include the name of the license and a link to the license file. For example, all Canonical repositories require a Contributor License Agreement (CLA) to be signed for contributions, include the instructions to sign the same. \#\# Contributing guidelines Link to the contributing file. \#\# Next steps (Optional) Include information on what the users can do next after the initial setup and configuration. \#\# Support You can get help and support at the following resources: \* \<link to project's docs site\> \* (Optional) \<link to project's GH issues\> \* (Optional) \<link to project's Discourse instance\> \* (Optional) \<link to parent or related projects\> </pre> </details> Supercedes #93 and #229. ## Acceptance criteria At minimum, the template should: 1. Be in Markdown format. READMEs don't build, so RST doesn't help here. 2. Cover installation and building (the get-up-and-go approach). 3. Link to relevant license and contribution docs.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Added the Craft project README template in merged PR canonical/starbase#387 (commit afc6663), covering Markdown setup, installation, builds, licensing, and contribution links.
stealth/space-bunny-alpha — closed resolved Added the Craft project README template via merged PR canonical/starbase#387 (commit afc6663), covering Markdown usage, installation, builds, licensing, and contribution links.
stealth/space-bunny-alpha — closed resolved Added a standard Markdown README template for craft projects via merged PR canonical/starbase#387 (commit afc6663), covering installation, building, licensing, and contribution guidance.
qwen/qwen3.6-35b-a3b — — 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.
qwen/qwen3.6-35b-a3b — — Implemented a standard README template for craft projects. Resolved via pull request 387 in canonical/starbase, fulfilling all acceptance criteria for markdown formatting, build instructions, and licensing links.
qwen3.6-35b-a3b-mtp-q6 — — A standard README template for craft projects was implemented and merged into the canonical/starbase repository via pull request #387, fulfilling the request and acceptance criteria.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/starbase#387 (confidence 100%)

    Merged PR that added the README template requested by issue #233.

Related issues

Issue Project State Summary Similarity
#93 README.rst template starbase closed Added a reusable README template and related documentation updates in canonical/starbase#387 (commit afc6663).
80%
#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.
77%
#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).
75%
#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.
75%
#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.
73%
#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.
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%
#16 readme: document how to contribute and work with the project craft-store merged Merged PR #16 via commit 51034f5, adding 58 lines of README guidance for contributing and working with craft-store.
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%
#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.
72%