Skip to content

Make Type of Change single-select without inflating GitHub task counts#1707

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/improve-pr-template-type-of-change
Closed

Make Type of Change single-select without inflating GitHub task counts#1707
Copilot wants to merge 3 commits intomainfrom
copilot/improve-pr-template-type-of-change

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 20, 2026

Description

This updates the PR template so Type of Change is clearly single-choice without using Markdown task-list syntax, preventing GitHub’s x/y tasks summary from counting those options as actionable tasks.

  • Template behavior
    • Replaced task-list checkboxes in Type of Change with plain ( ) markers.
    • Added explicit single-select instruction: change one ( ) to (x).
  • Task-count impact
    • Only real checklist items remain as - [ ] tasks under Checklist Before Submitting, so task progress now reflects actual submit/readiness items.
  • Updated section example
    ## Type of Change (select one)
    
    <!-- Select one option by changing `( )` to `(x)`. -->
    - ( ) Bug fix
    - ( ) New feature
    - ( ) Documentation update
    - ( ) Performance improvement
    - ( ) Code refactoring
    - ( ) Other (please specify):
  • UI preview

    PR template preview

Type of Change (select one)

  • ( ) Bug fix
  • ( ) New feature
  • (x) Documentation update
  • ( ) Performance improvement
  • ( ) Code refactoring
  • ( ) Other (please specify):

Related Issues

Checklist Before Submitting

  • My code has been tested locally.
  • Documentation has been updated as needed.
  • New or updated tests are included where applicable.
Original prompt

Create a pull request to improve the PR template so GitHub’s “x/y tasks” summary does not misleadingly count type-of-change options that are intended to be single-select.

Context:

  • Repo: intel/auto-round
  • A PR (example: support model_free WOQ quantization #1699) shows a tasks summary like “4/9 tasks” at the bottom, driven by Markdown task lists (- [ ] / - [x]) in the PR description.
  • The PR template currently includes a type-of-change section implemented as multiple checkboxes even though contributors should select only one. This causes GitHub to count those options as tasks, making the tasks summary misleading.

Requirements:

  1. Locate the PR template(s) used when opening a PR (likely under .github/pull_request_template.md or .github/PULL_REQUEST_TEMPLATE/*).
  2. Modify the type-of-change section so it is clearly single-choice but does NOT use Markdown task list checkboxes.
    • Example approaches:
      • Use a bullet list with radio-like markers e.g. - ( ) Bug fix (plain text), or
      • Use “delete the options that don’t apply” instructions, or
      • Use a single checkbox plus a text field.
    • Keep other genuinely multi-item “to-do” sections as checkboxes if they are meant to be tracked.
  3. Ensure the updated template renders nicely on GitHub and reduces misleading “x/y tasks” counting.
  4. Update any documentation or contributing guidelines if they reference the old checkbox behavior.
  5. Provide a concise PR description explaining why this change was made and how it affects the tasks summary.

Deliverables:

  • Commit(s) updating the relevant PR template file(s).
  • PR opened against the default branch.

The following is the prior conversation context from the user's chat exploration (may be truncated):

User: 我注意到PR的最后会有4/9 tasks 好像跟我们要勾选的内容有关,但是type-of-change这种本来就只用选一个,这个展示不好,所有PR都会有

Assistant: 这是 GitHub 在 PR 描述里识别到的 Markdown task list- [ ] / - [x])后,在页面底部自动汇总出来的 Tasks 进度(比如 4/9 tasks)。所以只要你们的 PR template 里有这种勾选项,几乎所有 PR 都会显示这个统计。

你提到的 type-of-change 这种“本来只选一个”的场景,如果模板把每个选项都写成 task list(checkbox),GitHub 就会把它们也当成“待办任务”计数,确实会让 4/9 这种展示变得不合理。

可选的改法(常见做法):

  1. type-of-change 从 checkbox 改成单选风格但不被计数:不用 - [ ],改用普通列表,例如:
    • - ( ) Bug fix
    • - ( ) New feature
    • - ( ) Breaking change
      或者用文字说明“请保留一个,删除其他行”。
  2. 仅把真正需要逐项完成的内容保留为 checkbox(比如 tests/doc/CI 等),这样 Tasks 统计更符合“完成度”。

官方文档里对“task list 会被 GitHub 作为任务跟踪/汇总”的行为在这里有描述:Changelog(你现在看到的 x/y tasks 属于 PR UI 对 task list 的呈现/汇总)。

User: 给个PR修复这个问题

Assistant: 我这边已经发起创建修复用的 PR 流程了,现在在等待你在弹窗里确认/允许继续执行;你确认后我就能继续生成并提交对应的 PR 修改。

This pull request was created from Copilot chat.

Copilot AI changed the title [WIP] Improve PR template to correct type-of-change options Make Type of Change single-select without inflating GitHub task counts Apr 20, 2026
Copilot AI requested a review from xin3he April 20, 2026 05:33
@xin3he xin3he closed this Apr 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants