Skip to content

[workflow] improve the bug report issue template and add a regression template - #6484

Open
JazyJiang wants to merge 1 commit into
mainfrom
chore/issue-templates
Open

JazyJiang wants to merge 1 commit into
mainfrom
chore/issue-templates

Conversation

@JazyJiang

@JazyJiang JazyJiang commented Oct 26, 2026 •

Copy link
Copy Markdown
Collaborator

Related issue

Closes #6483

Background

The bug report form only requires a free-text description: the environment is an optional free-text box and the reproduction script is a yes/no dropdown. In a review of the open issues, about a third could not be triaged without first asking for versions or a reproduction. There is no form for regressions after an update, and the wording assumes NVIDIA GPUs and CUDA. Details in the linked issue.

Changes

  • .github/ISSUE_TEMPLATE/bug-report.yml
    • New required fields: minimal reproduction, ColossalAI version or commit, PyTorch version, accelerator model with the number of devices and nodes.
    • New optional fields: error message and logs, Transformers version, accelerator software versions (CUDA / NCCL, torch_npu / CANN / HCCL, ROCm / RCCL), Booster plugin (dropdown), parallel configuration, output of colossalai check -i.
    • Removed: the "Do you feel comfortable sharing a script" dropdown (replaced by the reproduction field, which also accepts a description of the config when code cannot be shared) and the optional "Environment" box (split into the fields above).
    • Unchanged: title prefix, bug label, the two required checkboxes, the description field.
  • .github/ISSUE_TEMPLATE/regression.yml (new): title prefix [REGRESSION]: , label regression (already created in the repository).
    • Required: type of regression (speed, memory, accuracy / convergence, functionality; multiple choice), description, a before/after version table, before/after metrics, reproduction, accelerator.
    • Optional: logs, Booster plugin, parallel configuration.
  • All forms and config.yml: emoji removed from form names, field labels and contact link names. Nothing else in config.yml or the documentation, feature request and proposal forms changes; blank issues stay enabled.

User and compatibility impact

  • Issue reporters: filing a bug takes a few more fields; a report can no longer be submitted without a reproduction, versions and hardware. Blank issues remain available.
  • Existing issues: unaffected; issue forms only apply to new issues.
  • Code, Python API, checkpoints, CI, Docker, release: none.

Test environment and results

Issue forms are not covered by CI.

Check Result
Both files parsed as YAML; field ids are unique pass
Template chooser on a private scratch repository with these files: all six forms listed with no configuration error, blank issue and contact links still shown pass
Submitting the empty bug report form on the scratch repository: blocked, with "A required checkbox is missing" on both checkboxes and "Field can not be empty" on the first empty required field; bug label pre-selected pass
regression label exists, so the form applies it pass

The new bug form was also tried on a real bug on Ascend NPUs; this is why the hardware and backend fields are not CUDA-specific.

Known issues

  • colossalai check -i reports CUDA information only, and its "Found AOT CUDA Extension" line is always ✓. The form says it reports CUDA details only; the fix is tracked separately.

Risk and rollback

  • Risk: low. A YAML error would hide the form from the template chooser; the rendering check above covers that.
  • Rollback: revert this single commit. The regression label can stay.

Documentation and release impact

None.

… template

The bug report form only required a free-text description: the environment
was an optional free-text box and the reproduction script a yes/no
dropdown, so many reports could not be triaged without first asking for
versions.

Bug report: require a minimal reproduction, the ColossalAI version, the
PyTorch version and the accelerator, and add optional fields for logs,
Transformers, accelerator software (CUDA/NCCL, CANN/HCCL, ROCm/RCCL),
Booster plugin, parallel config and `colossalai check -i`.

Add a regression form with before/after versions and metrics, labelled
`regression`.

Drop the emoji from all issue form names, labels and contact links.

Closes #6483
@JazyJiang
JazyJiang force-pushed the chore/issue-templates branch from 7300dc9 to 3eeffcf Compare October 26, 2026 09:45
@JazyJiang
JazyJiang marked this pull request as ready for review October 26, 2026 09:56
@JazyJiang
JazyJiang requested a review from a team as a code owner October 26, 2026 09:56
@JazyJiang
JazyJiang requested a review from yuxuan-lou October 26, 2026 10:04
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.

[FEATURE]: Improve the bug report issue template and add a regression template

1 participant