docs: add contribution section, revise explanations
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Documentation updates merged, adding contribution sections and revised explanations. Maintainer confirmed retaining both the new docs and CONTRIBUTING.md for IDE convenience. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #6107 docs: improve the contribution guides more | snapcraft | merged | 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. | |
| #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. | |
| #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. | |
| #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). | |
| #1052 docs: Update README.md contributing link | rockcraft | merged | Merged a documentation update fixing a broken contributing link in README.md to point to CONTRIBUTING.md. Approved by three reviewers, passed CI checks, and applied as a single-line change. | |
| #1134 docs: add contributing.md | craft-parts | merged | Contributing guidelines were updated and moved to the standard contributing.md file. The change received two approvals, passed all CI checks, and was successfully merged. | |
| #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. | |
| #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. | |
| #2404 docs: update `CONTRIBUTING.md` | charmcraft | merged | Merged update to CONTRIBUTING.md incorporating changes from reviews in other repositories. Approved by three reviewers with no unresolved comments. All CI checks passed prior to merge. |