← 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

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.

Suggested action:

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
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 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.
80%
#1929 Docs: Harmonize README with template charmcraft open 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.
79%
#93 README.rst template starbase closed Implemented a consistent README.rst template for project inheritance. Resolved via pull request #387 in the canonical/starbase repository.
75%
#1199 docs: update README according to template craft-parts merged 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.
73%
#387 docs: add readme template starbase merged Merged after approval by two reviewers and successful CI checks. The pull request introduced a README template, adding 73 lines and removing 7 across two files to standardize project documentation.
72%
#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%