← Back to issue list

chore: remove comment fences from GitHub templates

View original Github issue

Metadata

Project
charmcraft
Number
#2581
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

Merged into main as commit 3425ccee, stripping HTML comment fences from four GitHub templates so contributors aren't confused by markup in checklists. Approved by 2 reviewers; docs-only change.

Resolution: closed resolved

Reason: PR #2581 was merged into main as commit 3425ccee ("chore: remove comment fences from GitHub templates (#2581)"), removing the <!-- --> wrappers around checklist items in .github/PULL_REQUEST_TEMPLATE.md and three other templates. The file history for .github/PULL_REQUEST_TEMPLATE.md shows the template is now plain markdown (fences gone), and review was approved with 0 unresolved comments.

Evaluated by: mr-cal-bot

No scores available.

Issue body

Some contributors don't recognise the HTML markup, so it's better to leave it out. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/charmcraft/blob/main/CONTRIBUTING.md). - [x] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). ~~- [ ] I've successfully run `make lint && make test`.~~ ~~- [ ] 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 Merged into main as commit 3425ccee, stripping HTML comment fences from four GitHub templates so contributors aren't confused by markup in checklists. Approved by 2 reviewers; docs-only change.
stealth/space-bunny-alpha — closed resolved Merged #2581 in commit 3425ccee, removing HTML comment fences from four GitHub templates to make contribution instructions clearer for contributors.
qwen/qwen3.6-35b-a3b — — Merged removal of HTML comment fences from GitHub templates to improve contributor clarity. Approved by two reviewers, passed CI checks, and updated four files.
qwen3.6-35b-a3b-mtp-q6 — — Merged a maintainer's change to remove HTML comment fences from GitHub templates. Contributors struggled with the markup, so templates were simplified to plain text. Applied directly without discussion or testing.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#2488 (confidence 88%)

    Commit 43e2e993 (PR #2488) originally added the PR template containing the comment fences that #2581 later removed.

  • Related To: canonical/charmcraft#2651 (confidence 70%)

    Commit 460e8df0 (PR #2651) later edited the same PR template checklist, confirming the fences remain removed.

  • Related To: canonical/charmcraft#498 (confidence 55%)

    Commit e8101418 has the same commit title for the same chore in an earlier era of the repo, suggesting a repeated cleanup pass over templates.

Related issues

Issue Project State Summary Similarity
#6084 chore: remove comment fences from GitHub templates snapcraft merged Merged PR #6084 as commit 333f167d0, stripping HTML comment fences from four GitHub templates (docs-only, +14/-14) so contributors see guidance as plain text; all CI checks passed.
94%
#281 chore: remove comment fences from GitHub templates imagecraft merged Merged as 2b37857: removed HTML comment fences from four GitHub templates to make contributor instructions less confusing.
92%
#1123 chore: remove comment fences from GitHub templates rockcraft merged Merged PR #1123 in commit 63635eca, removing HTML comment fences from four GitHub templates so contributor guidance appears as plain text.
92%
#498 chore: remove comment fences from GitHub templates starbase merged Merged PR #498 as commit e810141, removing comment fences from the GitHub pull-request template and aligning it with upstream Imagecraft and Snapcraft changes.
88%
#5882 chore: rework issue templates snapcraft merged Merged PR #5882 reworked GitHub issue templates, adding a documentation form, removing redundant security reporting, and cleaning up existing templates. Landed as c5d38b448.
75%
#2028 chore: two small non-code changes charmcraft merged Merged PR #2028 incorporated two small non-code updates across two files (+5/-2), with approval from two reviewers.
73%
#392 chore: remove codeowners starbase merged Merged commit 3b0bad9 removed the 9-line .github/CODEOWNERS file as agreed in standup; the PR was approved twice and all CI checks passed.
72%
#1776 chore: remove unused code charmcraft merged Merged PR #1776 as commit 027696be, deleting 17,571 lines of unused code across 36 files after maintainer review and approval.
72%
#2651 chore: add doc meta description to pr checklist charmcraft merged Merged as commit 460e8df0: a one-line chore to .github/PULL_REQUEST_TEMPLATE.md adding a checklist item requiring a doc meta description when changing documents.
71%
#1099 chore: fix linting craft-application merged Merged as 4c674c21, updating two files to clear Ty unused-directive lint errors; lint/files passed and review was approved.
71%