← Back to issue list

Move HACKING.rst to readthedocs

View original Github issue

Metadata

Project
starbase
Number
#229
Type
issue
State
closed
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Resolved by merged PR #448 (commit ebfec44), replacing HACKING.md with a reusable CONTRIBUTING.md contribution guide.

Resolution: closed resolved

Reason: PR #448 merged as commit ebfec44, adding CONTRIBUTING.md and deleting HACKING.md. A maintainer explicitly marked the issue resolved with #448.

Evaluated by: mr-cal-bot

No scores available.

Issue body

1. Migrate [HACKING.rst](https://github.com/canonical/starbase/blob/73db57b1229d04839367640b5e7c868d0259113f/HACKING.rst) to starbase documentation such that applications can re-use it in their documentation 2. Softlink or add a note in HACKING.rst pointing to the documentation - This is because developers except to see a hacking guide in the root of a repo

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Resolved by merged PR #448 (commit ebfec44), replacing HACKING.md with a reusable CONTRIBUTING.md contribution guide.
stealth/space-bunny-alpha — closed resolved Resolved by merged PR #448: replaced HACKING.md with a CONTRIBUTING.md template, streamlining contribution documentation.
qwen/qwen3.6-35b-a3b — — Resolved via PR #448. The proposal to migrate HACKING.rst to ReadTheDocs was superseded after a maintainer advocated keeping build instructions in the README or source-readable format. PR #448 implemented the resolution.
qwen/qwen3.6-35b-a3b — — Resolved via pull request #448. The HACKING.rst migration was superseded by consolidating build instructions into the README instead, avoiding the HACKING filename and aligning with standard repository practices.
qwen3.6-35b-a3b-mtp-q6 — — Superseded by PR #448. Maintainers declined migrating the guide to documentation, preferring to keep build instructions in the README or source files. The request was resolved via the referenced pull request.

Update history

No update history recorded yet.

Related work

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

    Merged PR #448 implemented the replacement contribution documentation.

Related issues

Issue Project State Summary Similarity
#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.
80%
#297 (draft): docs: reformat README, add HACKING craft-providers closed Superseded by merged PR #296; its README.rst conversion and HACKING.rst documentation landed in commit 1e16ba5.
77%
#55 Add hacking to README.md snapcraft merged Docs-only PR by ted-gould merged via commit 35af890e6, adding the hacking project to README.md (+1/-1). Approved by sergiusens (:+1:) on 2015-10-30.
76%
#910 Update HACKING.md snapcraft merged Docs-only PR merged as commit bccc3e4f9 ("Update HACKING.md (#910)", Nov 2016): dropped an obsolete testing section and relocated the testing instructions after the dependency-install steps in HACKING.md.
76%
#2568 docs: consolidate on a simple HACKING.md snapcraft merged Merged PR #2568 via commit d66877fc79, consolidating contributor setup and development guidance into one simple, consistent HACKING.md.
74%
#5578 docs: update CONTRIBUTING.md snapcraft merged Merged as 889bd6c79: refreshed CONTRIBUTING.md, removed HACKING.md, and reverted an unnecessary docs/conf.py change.
74%
#156 docs: update main project docs craft-cli merged 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.
71%
#162 docs(HACKING): update commit message guidelines starbase merged Merged PR #162 into main via commit 4b2c78e, making HACKING commit-message guidance more descriptive and authoritative.
70%
#131 Contributing documentation is not complete craft-providers closed Resolved by adding HACKING.rst, restoring tox in #295, removing Makefile, and skipping sudo-dependent integration tests by default in merged #328.
70%