← Back to issue list

docs: update HACKING.md to recurse submodules

View original Github issue

Metadata

Project
snapcraft
Number
#4006
Type
pull request
State
merged
Author
mr-cal
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #4006 in commit db9984a53, updating HACKING.md to clone with --recurse-submodules so snapd-testing-tools is available for Spread tests.

Resolution: closed resolved

Reason: PR #4006 was merged as commit db9984a53. The maintainer confirmed unrelated Ruby and Flutter spread-test failures were not blockers.

Evaluated by: mr-cal-bot

No scores available.

Issue body

- [X] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [X] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [X] Have you successfully run `make lint`? - [X] Have you successfully run `pytest tests/unit`? ----- A minor `HACKING.md` update requested by @giusebar. I recently added `snapd-testing-tools` as a submodule. This submodule is required for running spread tests, so now I've updated the hacking instructions.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #4006 in commit db9984a53, updating HACKING.md to clone with --recurse-submodules so snapd-testing-tools is available for Spread tests.
stealth/space-bunny-alpha — closed resolved PR #4006 merged as commit db9984a53 (Jan 2023); HACKING.md clone instructions changed to --recurse-submodules so the new snapd-testing-tools submodule required for spread tests is fetched. Guideline persists in CONTRIBUTING.md.
stealth/space-bunny-alpha — closed resolved Merged docs PR: HACKING.md clone/checkout instructions updated to recurse submodules, needed for the new snapd-testing-tools submodule used by spread tests. Merged as commit db9984a53.
stealth/space-bunny-alpha — closed resolved Merged #4006 as db9984a53, updating HACKING.md to initialize submodules recursively so snapd-testing-tools is available for spread tests.
stealth/space-bunny-alpha — closed resolved Merged PR #4006 (commit db9984a53) updated HACKING.md to require recursive submodule setup before running spread tests.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update to HACKING.md to document recursing into submodules for spread tests. Maintainer approved and merged the change, dismissing unrelated core18 test failures. Code coverage increased by 0.61%.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#4105 tests: check for submodules before running spread snapcraft merged Merged PR #4105 in commit 7921b04ed, adding a Spread preflight check that stops with a clear error when the snapd-testing-tools submodule is missing.
72%
#240 tests: check for submodules before running spread rockcraft merged Merged PR #240 as commit 3d940f71, adding a preflight check so spread tests report a clear error when the snapd-testing-tools submodule is missing.
72%
#1084 tests: check for submodules before running spread charmcraft merged Merged PR #1084 as commit bc890e84, adding a preflight check that clearly reports when the snapd-testing-tools submodule is missing before Spread tests run.
71%
#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.
71%