← Back to issue list

docs: tweaks to doc contribution guide

View original Github issue

Metadata

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

Current evaluation

Merged docs refinements to the contribution guide, clarifying the CODA transition and adding an RTD preview review step (commit 59b08c179).

Resolution: closed resolved

Reason: Pull request #6105 was approved and merged into main as commit 59b08c179; all reported CI checks passed.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Adjusting for some early external feedback: - Focus on the difficult items, make the list into a paragraph, and make the transition to CODA clearer. - Add RTD preview to review flow. --- - [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
stealth/space-bunny-alpha — closed resolved Merged docs refinements to the contribution guide, clarifying the CODA transition and adding an RTD preview review step (commit 59b08c179).
stealth/space-bunny-alpha — closed resolved Merged in #6105 via commit 59b08c179, refining the documentation contribution guide, clarifying the CODA transition, and adding an RTD preview review step.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged. Updated the documentation contribution guide by restructuring a list into a paragraph, clarifying the CODA transition, and adding an RTD preview to the review flow. A separate broken link noted in comments will be excluded due to a persistent 406 error.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#6085 docs: add contribution section, revise explanations snapcraft merged Docs PR merged as commit 38038b106: added docs/contribute/ (index, development, documentation), docs/about-documentation.rst and a second toctree; CONTRIBUTING.md was kept. Follow-ups: #6105, #6107.
76%
#5808 docs: fix typo in contribution guide snapcraft merged Merged PR #5808 by medubelko corrected a one-word typo in CONTRIBUTING.md (+1/-1); squashed as commit 0611c8100 with 2 approvals and docs-only CI passes.
76%
#1134 docs: add contributing.md craft-parts merged Merged #1134 in commit 71861d71, updating contribution guidelines and moving them to the standard CONTRIBUTING.md filename.
76%
#6107 docs: improve the contribution guides more snapcraft merged Merged documentation improvements in snapcraft#6107 via commit aced3d1aa, refining the commit workflow, testing guidance, and link accessibility.
76%
#1233 docs: update contribution guide. snapcraft merged Merged PR #1233 via commit 7d0158e67, updating CONTRIBUTING.md to remove the requirement for contributions to have an associated bug.
75%
#1142 docs: maintain contributing.md craft-parts merged Merged docs PR by maintainer medubelko fixing an error and improving a step in CONTRIBUTING.md (+3/-4 lines). Approved by 2 reviewers, all CI green; landed as commit 14b47207 ('docs: maintain contributing.md (#1142)').
73%
#2102 Add contributor instructions for contributing to documentation charmcraft closed Added documentation-contribution instructions via merged PR #2101 in commit 3af45555.
73%
#5637 docs: fix CONTRIBUTING.md typos snapcraft merged Docs-only PR merged as commit 4ad38c556, correcting typos and internal links in CONTRIBUTING.md (+3/-3, one file); approved by two reviewers.
72%
#150 docs: add contributing file rockcraft merged Merged PR #150 in commit 9ce3440e, adding a 17-line CONTRIBUTING.rst with code contribution guidelines.
72%
#2404 docs: update `CONTRIBUTING.md` charmcraft merged Merged docs PR #2404 as commit 1c0f9884, applying a small +5/-5 edit to CONTRIBUTING.md carrying over review feedback from other Canonical repos; 3 approvals, all CI green.
72%