← Back to issue list

docs: update `CONTRIBUTING.md`

View original Github issue

Metadata

Project
charmcraft
Number
#2382
Type
pull request
State
merged
Author
jahn-junior
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged with 2 approvals and all CI checks green, landing as commit 08bdaed6 ("docs: update `CONTRIBUTING.md` (#2382)") in the CONTRIBUTING.md history. The author held it pending discussion of `make setup`, then merged after lengau confirmed it was safe (2025-07-29).

Evaluated by: mr-cal-bot

No scores available.

Issue body

[Updated CONTRIBUTING.md](https://github.com/canonical/charmcraft/blob/work/update-contributing-guide/CHARMCRAFT-633/CONTRIBUTING.md)

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #2382 as commit 08bdaed6, revising CONTRIBUTING.md by 103 additions and 60 deletions; two reviewers approved and all CI checks passed.
qwen/qwen3.6-35b-a3b — — Merged after two reviewers approved and all CI checks passed. Updated CONTRIBUTING.md with 103 additions and 60 deletions. The author confirmed readiness to proceed following a brief discussion about make setup.
qwen3.6-35b-a3b-mtp-q6 — — Updated CONTRIBUTING.md was merged after the author linked a related PR and a reviewer confirmed it was safe to proceed. Documentation changes were approved and integrated.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2392 (confidence 80%)

    Follow-up linked by the author in a comment: installs system packages for `make setup` (commit 724cf55b), addressing the blocker the PR was held for.

  • Related To: canonical/charmcraft#2404 (confidence 80%)

    Later docs PR (commit 1c0f9884, +5/-5) further refining CONTRIBUTING.md, immediately after this one in the file's history.

  • Duplicate Of: canonical/charmcraft#2353 (confidence 45%)

    Prior 'docs: update CONTRIBUTING.md' commit 62abb2f4 in the same file history; a recurring docs refresh rather than a one-off.

Related issues

Issue Project State Summary Similarity
#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.
81%
#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.
80%
#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.
80%
#299 docs: update `CONTRIBUTING.md` craft-store merged Merged a documentation-only CONTRIBUTING.md update (+107/-52) as commit cabdfe3 after three approvals; tests, lint, and documentation checks passed despite two failing OSV-scanner jobs.
79%
#368 docs: update CONTRIBUTING.md craft-cli merged Merged PR #368 (commit e75f8ef) updated CONTRIBUTING.md to align with the project template, +107/-55 lines in one file; all CI checks passed.
79%
#5639 docs: update `CONTRIBUTING.md` snapcraft merged Merged docs-only PR updating CONTRIBUTING.md (+16/-18) to match Canonical cross-repo template changes, landing as commit 87afdc5b7 with 2 approvals; only store spread job failed.
78%
#841 docs: update `CONTRIBUTING.md` craft-application merged Merged PR #841, applying five CONTRIBUTING.md line replacements from reviews in other Canonical repositories; all CI checks passed.
77%
#791 docs: update CONTRIBUTING.md craft-application merged Docs-only PR #791 merged as commit 60bc3fae, rewriting CONTRIBUTING.md (+278/-319, 3 files) and deleting HACKING.md. Approved by 2 reviewers; only the OSV-scanner check failed.
77%
#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%
#2860 docs: fix copy error in README charmcraft merged Maintainer jahn-junior's one-line docs fix to a README copy error was approved by 2 reviewers and merged in commit 2664fc72 (+1/-3 lines in README.md); all CI checks passed.
76%