← Back to issue list

docs: update main project docs

View original Github issue

Metadata

Project
craft-cli
Number
#156
Type
pull request
State
merged
Author
tigarmo
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

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
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.
qwen3.6-35b-a3b-mtp-q6 Merged into main. Restored the HACKING.rst file and updated the README to reference it ahead of the 2.0.0 release. Code coverage remained unchanged.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#215 docs: add CONTRIBUTING.md imagecraft merged Merged into main, replacing HACKING.md with CONTRIBUTING.md. Approved by reviewers and passed all CI checks. Maintainer suggested future content trimming, but the documentation update was successfully integrated.
76%
#5578 docs: update CONTRIBUTING.md snapcraft merged Merged after approvals and passing CI. Updated CONTRIBUTING.md, removed HACKING.md, and reverted a redundant conf.py change. A reviewer noted a remaining README reference to HACKING.md requiring separate handling.
76%
#791 docs: update CONTRIBUTING.md craft-application merged Merged after reviewer approval and passing CI checks. Updated CONTRIBUTING.md and removed HACKING.md.
76%
#4006 docs: update HACKING.md to recurse submodules snapcraft merged Merged documentation update to HACKING.md instructing developers to recurse into submodules for spread tests. Approved by one reviewer and merged by maintainer @mr-cal, who dismissed unrelated test failures.
72%
#55 Add hacking to README.md snapcraft merged Merged a one-line README.md update adding the hacking project. Approved by sergiusens and integrated into the repository.
72%
#1104 docs: update links craft-parts merged Merged after two reviewers approved. Updated documentation to fix broken links. Integrated into the main branch despite some CI test failures.
71%
#31 docs: update main page with the standard template craft-archives merged Merged documentation update applying the standard template to the main page. Approved by one reviewer, passed CI checks, and added 12 lines to one file with no coverage impact.
70%
#162 docs(HACKING): update commit message guidelines starbase merged Merged updates to commit message guidelines in HACKING.rst for greater clarity. Approved by three reviewers, passed CI with 100% coverage, and modified three files. Minor commit type discussion did not block integration.
70%