← Back to issue list

docs: improve the contribution guides more

View original Github issue

Metadata

Project
snapcraft
Number
#6107
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged documentation updates improving the contribution guides. Changes reorder the commit phase, make the test step more active, and enhance link accessibility. Approved by two reviewers and merged after passing CI checks.

Suggested action: —

No scores available.

Issue body

Based on additional feedback from external reviewers: - Re-order the commit phase of the development guide. - Make the test step less passive. - Make actionable links more accessible. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. ~~- [ ] I've updated the relevant release notes.~~

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b — — Merged documentation updates improving the contribution guides. Changes reorder the commit phase, make the test step more active, and enhance link accessibility. Approved by two reviewers and merged after passing CI checks.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation update to the contribution guide based on external feedback. Changes include reordering the commit phase, clarifying test steps, and improving link accessibility. Approved and merged by the maintainer.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates to the contribution guidelines. Changes include reordering the commit phase, making test instructions more active, and improving link accessibility based on external reviewer feedback.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#1233 docs: update contribution guide. snapcraft merged Merged a documentation update removing the bug requirement from the contribution guide. A reviewer noted bugs aided regression testing and advised careful verification. The PR was approved and merged to reflect the updated workflow.
84%
#6085 docs: add contribution section, revise explanations snapcraft merged Merged documentation updates adding contribution guidelines, development instructions, and an about page. Approved by three reviewers and passed CI. Maintainers confirmed retaining CONTRIBUTING.md alongside the new docs.
84%
#5808 docs: fix typo in contribution guide snapcraft merged Merged a single-line documentation fix correcting a typo in the contribution guide. Approved by two reviewers and passed CI checks prior to integration.
83%
#1142 docs: maintain contributing.md craft-parts merged Merged a minor documentation update to contributing.md that corrected an error and improved a step. Approved by two reviewers with all CI checks passing. No changelog entry required.
83%
#254 docs: include contribution information rockcraft merged Merged following approval from three reviewers and passing CI checks. The change updates documentation with contribution guidelines, modifying four files (+84/-34 lines).
82%
#5586 docs: improve and move setup guides snapcraft merged Merged documentation update improving and relocating setup guides per internal feedback. Approved by two reviewers and passed CI checks. Changes span five files, streamlining contributor onboarding.
82%
#6105 docs: tweaks to doc contribution guide snapcraft merged Merged documentation updates to the contribution guide, including formatting tweaks, a clearer CODA transition, and RTD preview integration. Approved by four reviewers, passed CI checks, and addressed a broken GNOME GitLab link.
81%
#294 docs: add CONTRIBUTING.md craft-store merged Merged addition of CONTRIBUTING.md documentation. Approved by two reviewers and passed most CI checks. Minor discussions about local integration test instructions were noted but did not block the merge.
81%
#5637 docs: fix CONTRIBUTING.md typos snapcraft merged Merged documentation update correcting typos and internal links in CONTRIBUTING.md. Approved by two reviewers, passed CI checks, and applied with a minimal three-line change.
79%
#826 docs: update CONTRIBUTING.md craft-application merged Merged documentation update aligning CONTRIBUTING.md with the official template. Approved by three reviewers with all CI checks passing. The change modifies one file with 104 additions and 48 deletions.
79%