← Back to issue list

(draft): docs: reformat README, add HACKING

View original Github issue

Metadata

Project
craft-providers
Number
#297
Type
pull request
State
closed
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Superseded by merged PR #296; its README.rst conversion and HACKING.rst documentation landed in commit 1e16ba5.

Resolution: closed superseded

Reason: PR #297 was closed as redundant after its documentation changes were incorporated into PR #296. Merged commit 1e16ba5 added README.rst and HACKING.rst while removing README.md.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? ----- * Change `README.md` -> `README.rst` to match starbase. * Add `HACKING.rst` from starbase This builds on top of https://github.com/canonical/craft-providers/pull/296, so only the last commit needs review here. See https://github.com/canonical/craft-providers/issues/287. (CRAFT-1726)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed superseded Superseded by merged PR #296; its README.rst conversion and HACKING.rst documentation landed in commit 1e16ba5.
qwen/qwen3.6-35b-a3b — closed superseded Draft PR to reformat README and add HACKING.rst. Closed and superseded by PR #296, which incorporated these documentation updates.

Update history

Date Change
created

Related work

  • Superseded By: canonical/craft-providers#296 (confidence 100%)

    The merged documentation restructuring incorporated the changes proposed by draft PR #297.

  • Related To: canonical/craft-providers#287 (confidence 98%)

    PR #297 explicitly targeted the broader synchronization of craft-providers with starbase.

Related issues

Issue Project State Summary Similarity
#229 Move HACKING.rst to readthedocs starbase closed Resolved by merged PR #448 (commit ebfec44), replacing HACKING.md with a reusable CONTRIBUTING.md contribution guide.
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.
74%
#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.
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.
72%
#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.
72%
#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.
71%
#184 docs(HACKING): clarify commit header for merges starbase merged Docs-only PR by maintainer mr-cal merged into main as commit 234b360, clarifying HACKING.rst guidance on the conventional-commit header used for merge commits (+4/-1 in HACKING.rst).
71%