Docs: Harmonize README with template
Metadata
Current evaluation
Closed without implementation. The README harmonization request was abandoned after an internal Jira ticket was created. No code changes or merges occurred.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Closed without implementation. The README harmonization task was abandoned due to unmet dependencies and lack of follow-up. |
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. | |
| #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. | |
| #881 docs: harmonize readme with template | rockcraft | merged | Merged after harmonizing the README with the project template. Required running make autoformat to resolve linting failures. Approved by two reviewers with all CI checks passing. Modified three files, adding 90 and removing 189 lines. |