← Back to issue list

docs: add contribution section, revise explanations

View original Github issue

Metadata

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

Current evaluation

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.

Resolution: closed resolved

Reason: PR #6085 was approved by 3 reviewers and merged into main as commit 38038b106, whose git log entries for docs/contribute/index.rst and docs/contribute/development.rst match the title. The author confirmed in the closing comment that CONTRIBUTING.md was intentionally retained.

Evaluated by: mr-cal-bot

No scores available.

Issue body

**Preview**: https://canonical-ubuntu-documentation-library--6085.com.readthedocs.build/snapcraft/6085/contribute/ - Rename and rewrite 'Contribute to this documentation'. - Add 'Contribute to development'. - Add 'About this documentation'. - Add second toctree. --- - [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 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.
stealth/space-bunny-alpha — closed resolved Merged in #6085 via commit 38038b106, adding contribution and development guidance, an about page, and a second toctree while retaining CONTRIBUTING.md.
qwen/qwen3.6-35b-a3b — — 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.
qwen3.6-35b-a3b-mtp-q6 — — Merged documentation updates adding contribution sections and project info. Discussed removing CONTRIBUTING.md but decided to retain it for IDE workflows alongside the new docs.

Update history

No update history recorded yet.

Related work

  • Related To: snapcraft#6105 (confidence 88%)

    'docs: tweaks to doc contribution guide' follows up on the same files introduced here.

  • Related To: snapcraft#6107 (confidence 80%)

    'docs: improve the contribution guides more' continues work on docs/contribute/development.rst.

  • Related To: snapcraft#6227 (confidence 45%)

    Later pattern-compliance updates to docs/about-documentation.rst added by this PR.

Related issues

Issue Project State Summary Similarity
#150 docs: add contributing file rockcraft merged Merged PR #150 in commit 9ce3440e, adding a 17-line CONTRIBUTING.rst with code contribution guidelines.
77%
#2102 Add contributor instructions for contributing to documentation charmcraft closed Added documentation-contribution instructions via merged PR #2101 in commit 3af45555.
77%
#2101 feat(docs): instructions for contributing to the docs charmcraft merged Merged PR #2101 added documentation-contribution setup instructions, including docs development-environment guidance; commit 3af45555 fixes #2102.
76%
#6105 docs: tweaks to doc contribution guide snapcraft merged Merged docs refinements to the contribution guide, clarifying the CODA transition and adding an RTD preview review step (commit 59b08c179).
76%
#1052 docs: Update README.md contributing link rockcraft merged Merged PR #1052 (commit 509abf1a) fixed the broken contributing link in README.md, pointing it to CONTRIBUTING.md instead of the stale URL. Docs-only, +1/-1 lines; approved by 3 reviewers.
76%
#2382 docs: update `CONTRIBUTING.md` charmcraft merged Docs-only PR by maintainer jahn-junior merged as commit 08bdaed6 (+103/-60), rewriting CONTRIBUTING.md; follow-up fixes landed in #2392 (make setup system packages) and #2404.
76%
#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.
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.
75%
#370 docs: update `CONTRIBUTING.md` craft-cli merged Merged PR #370 (commit b7a0dbb), aligning CONTRIBUTING.md with the project template and incorporating review wording changes.
75%
#5628 docs: update CONTRIBUTING.md snapcraft merged CONTRIBUTING.md was overhauled and merged in PR #5628 as commit e76eb27c6; commit 52e61041 corrected an accidental revert before merge.
75%