docs: update main project docs
Metadata
Current evaluation
Docs PR merged as commit 74150b7 by maintainer tigarmo: restored Starbase's HACKING.rst and updated README to point at it, ahead of the 2.0.0 release. HACKING.rst later gave way to CONTRIBUTING.md.
Resolution: closed resolved
Reason: The pull request was approved and merged into main as commit 74150b7 ("docs: update main project docs (#156)"), which touched4 files (+113/-62), adding back HACKING.rst and updating the README. The file did not survive to current HEAD because it was replaced by CONTRIBUTING.md in #352, and later updated in #368/#370.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Add back Starbase's HACKING.rst and cleanup the README to reference it.
I think it's a good idea to do this before doing the actual 2.0.0 release.
- [ ] Have you followed the guidelines for contributing?
- [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [ ] Have you successfully run `tox`?
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Docs PR merged as commit 74150b7 by maintainer tigarmo: restored Starbase's HACKING.rst and updated README to point at it, ahead of the 2.0.0 release. HACKING.rst later gave way to CONTRIBUTING.md. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as 74150b7: restored HACKING.rst and updated README to reference it, preparing documentation for the 2.0.0 release. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged PR #156 restored Starbase’s HACKING.rst and updated README links to it, preparing craft-cli documentation for 2.0.0. Coverage remained unchanged. | |
| qwen/qwen3.6-35b-a3b | — | — | Merged into main after approval. Restores HACKING.rst and updates README to reference it, preparing documentation for the 2.0.0 release. Code coverage unchanged. |
Update history
No update history recorded yet.
Related work
-
Superseded By:
canonical/craft-cli#352
(confidence 80%)
HACKING.rst added by #156 no longer exists at HEAD; commit 6059480 added CONTRIBUTING.md, replacing it. The #156 work itself was merged successfully.
-
Related To:
canonical/craft-cli#340
(confidence 55%)
Commit e05899f ("chore: prepare for starbase merge") later touched HACKING.rst during the Starbase merge into craft-cli.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #152 Integrate Starbase's top-level project docs | craft-cli | closed | Updated top-level docs after Starbase: PR #156 (commit 74150b7) added the HACKING document and linked it from README. | |
| #448 docs: add `CONTRIBUTING.md` template | starbase | merged | PR #448 merged, adding a CONTRIBUTING.md template to Starbase and deleting HACKING.md, streamlining the contribution/merge process. Landed as commit ebfec44. | |
| #416 docs: update contribution links | starbase | merged | Docs-only PR merged as commit 96a080d, updating Starbase's contribution links in docs/index.rst to match Snapcraft's docs; approved by 2 reviewers with all CI checks green. | |
| #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. | |
| #791 docs: update CONTRIBUTING.md | craft-application | merged | Docs-only PR #791 merged as commit 60bc3fae, rewriting CONTRIBUTING.md (+278/-319, 3 files) and deleting HACKING.md. Approved by 2 reviewers; only the OSV-scanner check failed. | |
| #215 docs: add CONTRIBUTING.md | imagecraft | merged | Merged PR #215 in commit b0aa9f2, replacing HACKING.md with a 312-line CONTRIBUTING.md aligned to the project's contribution model. | |
| #336 docs: fix some formatting errors in README | starbase | merged | Docs-only PR merged as commit d3d4189, adding 10 lines to starbase's README to fix spacing/formatting errors that slipped past the earlier README cleanup in #331 (commit de0d308). Approved by 2 reviewers, no CI. | |
| #5578 docs: update CONTRIBUTING.md | snapcraft | merged | Merged as 889bd6c79: refreshed CONTRIBUTING.md, removed HACKING.md, and reverted an unnecessary docs/conf.py change. | |
| #353 docs: clarify the steps for merging starbase into a project | starbase | merged | Merged PR #353 in commit 3fe73bf, adding two documentation lines clarifying how to merge starbase into a project. | |
| #225 docs(HACKING): add details on changelog convention | starbase | merged | Merged #225, adding 27 lines to HACKING.md to document Starbase's changelog convention, adapted from canonical/craft-application#377. |