Skip to content

Use html list for checklist to prevent showing tasks in PR list - #113

Open
juhoinkinen wants to merge 1 commit into
mainfrom
pr-template-revision
Open

Use html list for checklist to prevent showing tasks in PR list#113
juhoinkinen wants to merge 1 commit into
mainfrom
pr-template-revision

Conversation

@juhoinkinen

Copy link
Copy Markdown
Member

Reasons for creating this PR

PR list shows "2 tasks done" for each PR because the PR description includes two markdown checkboxes:

image

Instead, when a html list is used, tasks won't be shown, e.g. the bottom PR (but this makes the checkboxes non-functional, they cannot be checked by clicking):
image

Found this out from this discussion.

Link to relevant issue(s), if any

  • Closes #

Description of the changes in this PR

Instructions how to test this PR

Known problems or uncertainties in this PR

Is cleaner PR list worth of making the checkboxes non-functional?

Checklist

  • I have added tests that show that the new code works, or tests are not relevant for this PR (e.g. only HTML/CSS changes)
  • The PR doesn't introduce unintended code changes (e.g. empty lines or useless reindentation)

Disclosure of AI Tool Usage

Please indicate AI use by choosing the most suitable TLP:AI category below and removing the irrelevant categories from the list. AI:ORANGE is the minimum level for merging.

  • ⚪ AI:WHITE Written independently, no significant AI involvement.
    Describe the AI tool(s) you used:

@juhoinkinen juhoinkinen added documentation Improvements or additions to documentation maintenance labels Aug 27, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.50%. Comparing base (ef35240) to head (008edf7).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #113   +/-   ##
=======================================
  Coverage   98.50%   98.50%           
=======================================
  Files          13       13           
  Lines         536      536           
=======================================
  Hits          528      528           
  Misses          8        8           
Flag Coverage Δ
unittests 98.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@juhoinkinen juhoinkinen added this to the 0.2 milestone Aug 27, 2026
@juhoinkinen
juhoinkinen marked this pull request as ready for review August 27, 2026 12:23
@juhoinkinen
juhoinkinen requested a review from osma September 8, 2026 07:33
@osma

osma commented Sep 8, 2026

Copy link
Copy Markdown
Member

Is cleaner PR list worth of making the checkboxes non-functional?

I'd say no - why bother with making a checklist with checkboxes if they don't work?

How about something simpler like this plain list:

Checklist

By marking this PR as ready for review, I confirm that

  • I have added tests that show that the new code works, or tests are not relevant for this PR (e.g. only HTML/CSS changes)
  • The PR doesn't introduce unintended code changes (e.g. empty lines or useless reindentation)

@juhoinkinen

Copy link
Copy Markdown
Member Author

Is cleaner PR list worth of making the checkboxes non-functional?

I'd say no - why bother with making a checklist with checkboxes if they don't work?

Maybe I should have called the checkboxes semi-functional: they are rendered normally (like here), they just cannot be toggled by clicking, only be editing the markdown. The PR description anyway needs to be edited, so it is not too much extra work to select them.

Just having a plain list for confimation does not feel the same way enforcing like actively checking a box.

But in the end, I think the two points of the checklist have not been a problem anyway. 🤷

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants