← Back to issue list

Add contributor instructions for contributing to documentation

View original Github issue

Metadata

Project
charmcraft
Number
#2102
Type
issue
State
closed
Author
lengau
Labels
—
Created
Updated
Closed

Current evaluation

Added documentation-contribution instructions via merged PR #2101 in commit 3af45555.

Resolution: closed resolved

Reason: Repository history records commit 3af45555, “feat(docs): instructions for contributing to the docs,” through PR #2101, implementing the requested contributor instructions.

Evaluated by: mr-cal-bot

No scores available.

Issue body

### What needs to get done Add instructions for contributing to the documentation ### Why it needs to get done Right now this is undocumented.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Added documentation-contribution instructions via merged PR #2101 in commit 3af45555.
stealth/space-bunny-alpha — closed resolved Documentation contribution guidance was added in PR #2101 via commit 3af45555.
stealth/space-bunny-alpha — closed resolved Documentation contribution instructions were added by merged PR #2101 in commit 3af45555.
stealth/space-bunny-alpha — closed stale Documentation-contributor task was closed without a recorded fix; the only comment created internal ticket CRAFT-3985, with no linked PR or commit.
qwen3.6-35b-a3b-mtp-q6 — — Abandoned. Documentation contribution instructions were not added. The request closed without implementation after syncing to an internal Jira ticket.
qwen/qwen3.6-35b-a3b — — Closed without resolution. The request to add documentation contributor guidelines was abandoned and deferred to internal Jira ticket CRAFT-3985. No changes were merged.
qwen/qwen3.6-35b-a3b — — Closed without implementation. The request to add documentation contributor guidelines was synced to Jira but received no further action, leaving the documentation gap unaddressed.
qwen3.6-35b-a3b-mtp-q6 — — Closed without implementation. No resolution or merge details were provided, leaving the request to document contribution guidelines unaddressed.

Update history

No update history recorded yet.

Related work

  • Likely Fixed By: canonical/charmcraft#2101 (confidence 99%)

    PR #2101 added the requested documentation-contribution guidance in commit 3af45555.

Related issues

Issue Project State Summary Similarity
#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.
85%
#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.
77%
#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.
77%
#150 docs: add contributing file rockcraft merged Merged PR #150 in commit 9ce3440e, adding a 17-line CONTRIBUTING.rst with code contribution guidelines.
76%
#925 docs: add `CONTRIBUTING.md` rockcraft merged Merged as 3d63a806, replacing CONTRIBUTING.rst with updated CONTRIBUTING.md contributor guidelines.
74%
#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.
74%
#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.
73%
#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).
73%
#157 Add contribution guide. snapcraft merged PR #157 by kyrofa merged a new CONTRIBUTING.md (32 lines) with contributor guidelines, plus the Ubuntu CLA link requested in review; GitHub now surfaces it for all PRs.
72%
#2181 docs(contributing): add ccla charmcraft closed CCLA contribution guidance from #2181 was superseded by merged docs PR #2353 (commit 62abb2f4), which updated CONTRIBUTING.md more broadly.
72%