← Back to issue list

feat(docs): instructions for contributing to the docs

View original Github issue

Metadata

Project
charmcraft
Number
#2101
Type
pull request
State
merged
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Merged PR #2101 added documentation-contribution setup instructions, including docs development-environment guidance; commit 3af45555 fixes #2102.

Resolution: closed resolved

Reason: PR #2101 was merged with commit 3af45555, adding the requested contributing instructions and resolving #2102.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This adds contributing instructions for writing documentation, specifically about creating your development environment for docs. Fixes #2102 CRAFT-3985

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged PR #2101 added documentation-contribution setup instructions, including docs development-environment guidance; commit 3af45555 fixes #2102.
stealth/space-bunny-alpha — closed resolved Merged PR #2101 in commit 3af45555, adding documentation-contribution guidance and docs development-environment setup instructions; it fixes #2102.
stealth/space-bunny-alpha — closed resolved Merged in #2101 as commit 3af45555, adding docs contribution and development-environment setup instructions and fixing #2102; commit 5b96ab4 added follow-up refinements.
stealth/space-bunny-alpha — closed resolved Merged in #2101 (commit 3af45555), adding documentation contribution instructions and development-environment setup; it explicitly fixes #2102.
qwen/qwen3.6-35b-a3b — — Added documentation contribution guidelines covering development environment setup. Approved by a reviewer, incorporated additional updates, and merged to resolve issue #2102.
qwen3.6-35b-a3b-mtp-q6 — — Added documentation contribution guidelines and development environment setup instructions. Resolves #2102 and CRAFT-3985. Merged after maintainer authored the initial changes and subsequent updates were applied.

Update history

No update history recorded yet.

Related work

Related issues

Issue Project State Summary Similarity
#2102 Add contributor instructions for contributing to documentation charmcraft closed Added documentation-contribution instructions via merged PR #2101 in commit 3af45555.
85%
#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%
#150 docs: add contributing file rockcraft merged Merged PR #150 in commit 9ce3440e, adding a 17-line CONTRIBUTING.rst with code contribution guidelines.
73%
#237 docs: add docs items to PR template imagecraft merged Merged PR #237 via commit 9f3f1a2, adding documentation-maintenance checklist items and a CONTRIBUTING.md link to the PR template.
72%
#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.
72%
#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.
70%
#325 docs: add a documentation response protocol rockcraft merged Merged #325 in commit 5706a4ab, adding documentation contribution guidance and expected responses for issues and external-contributor PRs.
70%
#1197 docs: align `CONTRIBUTING.md` with template craft-parts merged Merged docs-only PR #1197 (commit 41cbe718) aligning CONTRIBUTING.md with the craft project template, +147/-89 lines; follow-up to earlier CONTRIBUTING work in #1134/#1142.
70%
#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.
70%