← Back to issue list

chore: remove comment fences from GitHub templates

View original Github issue

Metadata

Project
snapcraft
Number
#6084
Type
pull request
State
merged
Author
medubelko
Labels
—
Created
Updated
Closed

Current evaluation

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.

Resolution: closed resolved

Reason: The PR itself was merged into snapcraft's main branch as commit 333f167d0, approved by 2 reviewers with all CI checks passing. The change removed <!-- --> fences from .github templates including PULL_REQUEST_TEMPLATE.md, and a later commit c4a774047 (#6181) built on the updated template.

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/snapcraft/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 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.
stealth/space-bunny-alpha — closed resolved Merged #6084 (commit 333f167d0), removing HTML comment fences from four GitHub templates so contributors recognize the guidance more easily.
qwen/qwen3.6-35b-a3b — — Removed HTML comment fences from GitHub templates to improve contributor recognition. Merged after maintainer approval and passing all CI checks across four files.
qwen3.6-35b-a3b-mtp-q6 — — Merged a maintainer's change to remove HTML comment fences from GitHub templates. The update replaces unrecognized HTML markup with plain text to improve template readability and contributor experience.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/rockcraft#1123 (confidence 82%)

    Same chore mirrored across the Canonical craft suite; rockcraft PR #1123 removed comment fences from its four GitHub templates.

  • Related To: canonical/imagecraft#281 (confidence 78%)

    Identical cross-project cleanup merged as 2b37857 in imagecraft.

  • Related To: canonical/charmcraft#2581 (confidence 76%)

    Same change applied to charmcraft templates (commit 3425ccee).

Related issues

Issue Project State Summary Similarity
#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.
95%
#2581 chore: remove comment fences from GitHub templates charmcraft merged 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.
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.
91%
#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%
#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.
71%
#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.
71%
#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.
70%
#585 chore(linter): misc fixes craft-parts merged Merged PR #585 with miscellaneous linter fixes across 125 files, preserving individual commits rather than squashing, as requested.
70%