← Back to issue list

docs: consolidate on a simple HACKING.md

View original Github issue

Metadata

Project
snapcraft
Number
#2568
Type
pull request
State
merged
Author
sergiusens
Labels
Created
Updated
Closed

Current evaluation

Merged into master. Consolidates development setup and contribution guidelines into a single HACKING.md file for consistency and easier onboarding. Approved by a reviewer, passed CI checks, and integrated without impacting code coverage.

Suggested action:

No scores available.

Issue body

Make it consistent to a single environment and easier to setup. Signed-off-by: Sergio Schvezov <sergio.schvezov@canonical.com> - [ ] Have you followed the [guidelines for contributing](https://github.com/snapcore/snapcraft/blob/master/CONTRIBUTING.md)? - [ ] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)? - [ ] Have you successfully run `./runtests.sh static`? - [ ] Have you successfully run `./runtests.sh tests/unit`? -----

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b Merged into master. Consolidates development setup and contribution guidelines into a single HACKING.md file for consistency and easier onboarding. Approved by a reviewer, passed CI checks, and integrated without impacting code coverage.
qwen3.6-35b-a3b-mtp-q6 Merged into master. Consolidated contributor documentation into a single HACKING.md file to standardize the development environment. Approved following static checks and codecov verification showing no coverage change.
qwen3.6-35b-a3b-mtp-q6 Merged into master. Consolidated development documentation into a single HACKING.md file to standardize the environment and simplify setup. Approved by maintainers with no change to code coverage.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#791 docs: update CONTRIBUTING.md craft-application merged Merged after reviewer approval and passing CI checks. Updated CONTRIBUTING.md and removed HACKING.md.
81%
#184 docs(HACKING): clarify commit header for merges starbase merged Merged a documentation update to the HACKING file to clarify commit header guidelines for merges. The change was approved by a reviewer and successfully integrated.
78%
#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.
78%
#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.
78%
#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.
77%
#448 docs: add `CONTRIBUTING.md` template starbase merged Merged after receiving two approvals and passing all CI checks. Added a CONTRIBUTING.md template to streamline the contribution process and removed the outdated HACKING.md file.
77%
#346 docs(HACKING): add note about revert commits starbase merged Merged documentation update to the HACKING guide. Added guidance on formatting revert commits using conventional commit standards. Approved by one reviewer, passed CI checks, and merged with a single line addition.
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.
75%
#910 Update HACKING.md snapcraft merged Merged a documentation update to HACKING.md that removes an obsolete testing section and relocates it after dependency installation. The change was approved by a reviewer with a follow-up question.
73%
#349 style(HACKING): fix typo starbase merged Merged a one-line typo fix in the HACKING file. Approved by one reviewer with passing CI checks. The change corrects a spelling error in the contributing guidelines.
72%