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

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -1,4 +1,4 @@
-name: 🐛 Bug Report
+name: Bug Report
 description: Create a report to help us reproduce and fix the bug
 title: "[BUG]: "
 labels: [bug]
@@ -23,26 +23,13 @@ body:
     - label: I have checked the latest main branch
       required: true
 
-- type: dropdown
-  id: share_script
-  attributes:
-    label: Do you feel comfortable sharing a concise (minimal) script that reproduces the error? :)
-    description: If not, please share your setting/training config, and/or point to the line in the repo that throws the error.
-              If the issue is not easily reproducible by us, it will reduce the likelihood of getting responses.
-    options:
-      - Yes, I will share a minimal reproducible script.
-      - No, I prefer not to share.
-  validations:
-    required: true
-
 - type: textarea
+  id: description
   attributes:
-    label: 🐛 Describe the bug
+    label: Describe the bug
     description: |
       **Describe the bug**
       A clear and concise description of what the bug is.
-      **To Reproduce**
-      Steps or code snippet to reproduce the behavior.
       **Expected behavior**
       A clear and concise description of what you expected to happen.
       **Screenshots**
@@ -53,13 +40,95 @@ body:
       A clear and concise description of what the bug is.
   validations:
     required: true
+
 - type: textarea
+  id: reproduction
   attributes:
-    label: Environment
+    label: Minimal reproduction
     description: |
-      Please provide the environment information, eg. CUDA/cuDNN/NCCL/Python/PyTorch version.
+      A minimal script and the exact command that reproduce the bug, e.g. `colossalai run --nproc_per_node 4 repro.py`.
+      If you cannot share code, describe your training config (plugin, parallel sizes, model, batch size) and point to the line in the repo that throws the error.
+      Issues we cannot reproduce are less likely to get a response.
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  id: logs
+  attributes:
+    label: Error message and logs
+    description: The full traceback or the relevant part of the log.
+    render: shell
+
+- type: input
+  id: colossalai_version
+  attributes:
+    label: ColossalAI version or commit
+    description: Output of `pip show colossalai`, or the commit hash if installed from source.
+    placeholder: e.g. 0.5.0, or main @ cb3b223
+  validations:
+    required: true
+
+- type: input
+  id: torch_version
+  attributes:
+    label: PyTorch version
+    description: Output of `python -c "import torch; print(torch.__version__)"`.
+    placeholder: e.g. 2.13.0+cu130
+  validations:
+    required: true
+
+- type: input
+  id: hardware
+  attributes:
+    label: Accelerator model, number of devices and nodes
+    description: GPU, NPU or other accelerator.
+    placeholder: e.g. 8 x H100 80GB, 2 nodes; or 16 x Ascend 910B2, 2 nodes
+  validations:
+    required: true
+
+- type: input
+  id: transformers_version
+  attributes:
+    label: Transformers version
+    description: Fill in if a Hugging Face model is involved.
+    placeholder: e.g. 4.51.3
+
+- type: input
+  id: backend_versions
+  attributes:
+    label: Accelerator software versions
+    description: CUDA / NCCL for NVIDIA GPUs, torch_npu / CANN / HCCL for Ascend NPUs, ROCm / RCCL for AMD GPUs.
+    placeholder: e.g. CUDA 13.0, NCCL 2.28.9; or torch_npu 2.13, CANN 9.1.0, HCCL
+
+- type: dropdown
+  id: plugin
+  attributes:
+    label: Booster plugin
+    options:
+      - TorchDDPPlugin
+      - LowLevelZeroPlugin
+      - GeminiPlugin
+      - HybridParallelPlugin
+      - MoeHybridParallelPlugin
+      - TorchFSDPPlugin
+      - Other / not applicable
+
+- type: input
+  id: parallel_config
+  attributes:
+    label: Parallel configuration
+    description: Fill in if relevant.
+    placeholder: e.g. tp_size=2, pp_size=2, sp_size=1, ep_size=1, zero_stage=1
+
+- type: textarea
+  id: check_installation
+  attributes:
+    label: Output of `colossalai check -i`
+    description: Optional. Collects the installation information in one step; it currently reports CUDA details only.
+    render: shell
 
 - type: markdown
   attributes:
     value: >
-      Thanks for contributing 🎉!
+      Thanks for contributing!

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,11 @@
 blank_issues_enabled: true
 contact_links:
-  - name: ❓ Simple question - Slack Chat
+  - name: Simple question - Slack Chat
     url: https://github.com/hpcaitech/public_assets/tree/main/colossalai/contact/slack
     about: This issue tracker is not for technical support. Please use our Slack chat, and ask the community for help.
-  - name: ❓ Simple question - WeChat
+  - name: Simple question - WeChat
     url: https://github.com/hpcaitech/ColossalAI/blob/main/docs/images/WeChat.png
     about: This issue tracker is not for technical support. Please use WeChat, and ask the community for help.
-  - name: 😊 Advanced question - GitHub Discussions
+  - name: Advanced question - GitHub Discussions
     url: https://github.com/hpcaitech/ColossalAI/discussions
     about: Use GitHub Discussions for advanced and unanswered technical questions, requiring a maintainer's answer.

.github/ISSUE_TEMPLATE/documentation.yml

@@ -1,4 +1,4 @@
-name: 📚 Documentation
+name: Documentation
 description: Report an issue related to https://www.colossalai.org/
 title: "[DOC]: "
 labels: [documentation]
@@ -10,7 +10,7 @@ body:
       #### Not suitable for your needs? [Open a blank issue](https://github.com/hpcaitech/ColossalAI/issues/new).
 - type: textarea
   attributes:
-    label: 📚 The doc issue
+    label: The doc issue
     description: |
       **Description** What content in [Documentation](https://www.colossalai.org/) is an issue?
       **Location** Where is the issue location?
@@ -26,4 +26,4 @@ body:
 - type: markdown
   attributes:
     value: >
-      Thanks for contributing 🎉!
+      Thanks for contributing!

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,4 +1,4 @@
-name: 🚀 Feature request
+name: Feature request
 description: Suggest an idea for this project
 title: "[FEATURE]: "
 labels: [enhancement]
@@ -32,4 +32,4 @@ body:
 - type: markdown
   attributes:
     value: >
-      Thanks for contributing 🎉!
+      Thanks for contributing!

.github/ISSUE_TEMPLATE/proposal.yml

@@ -1,4 +1,4 @@
-name: 💥 Proposal
+name: Proposal
 description: Propose a non-trivial change to Colossal-AI
 title: "[PROPOSAL]: "
 labels: [enhancement]
@@ -44,4 +44,4 @@ body:
 - type: markdown
   attributes:
     value: >
-      Thanks for contributing 🎉!
+      Thanks for contributing!

.github/ISSUE_TEMPLATE/regression.yml

@@ -0,0 +1,119 @@
+name: Regression
+description: Something got slower, used more memory, lost accuracy or stopped working after updating ColossalAI or a dependency
+title: "[REGRESSION]: "
+labels: [regression]
+
+body:
+- type: markdown
+  attributes:
+    value: >
+      Use this form when the same workload behaved better on an older version.
+      For a bug without a known-good version, please use the Bug Report form instead.
+- type: checkboxes
+  attributes:
+    label: Is there an existing issue for this regression?
+    description: Please search [here](https://github.com/hpcaitech/ColossalAI/issues) to see if an open or closed issue already exists.
+    options:
+    - label: I have searched the existing issues
+      required: true
+
+- type: dropdown
+  id: regression_type
+  attributes:
+    label: Type of regression
+    multiple: true
+    options:
+      - Speed / throughput
+      - Memory usage
+      - Accuracy / convergence (loss, grad norm, eval results)
+      - Functionality (it used to work and now fails)
+  validations:
+    required: true
+
+- type: textarea
+  id: description
+  attributes:
+    label: Describe the regression
+    description: What changed, and how did you notice it?
+  validations:
+    required: true
+
+- type: textarea
+  id: versions
+  attributes:
+    label: Versions before and after
+    description: |
+      The known-good and the regressed setup. Include whatever changed between the two.
+    value: |
+      |                                           | Before (good) | After (regressed) |
+      | ----------------------------------------- | ------------- | ----------------- |
+      | ColossalAI                                |               |                   |
+      | PyTorch                                   |               |                   |
+      | Transformers                              |               |                   |
+      | CUDA / NCCL (or CANN / HCCL, ROCm / RCCL) |               |                   |
+  validations:
+    required: true
+
+- type: textarea
+  id: metrics
+  attributes:
+    label: Metrics before and after
+    description: |
+      The numbers that changed, measured on the same hardware and config,
+      e.g. tokens/s, step time, peak memory, loss after N steps.
+    placeholder: |
+      Before: 1520 tokens/s per device, peak memory 61.2 GB
+      After:  1180 tokens/s per device, peak memory 63.0 GB
+  validations:
+    required: true
+
+- type: textarea
+  id: reproduction
+  attributes:
+    label: Reproduction
+    description: |
+      A script and the exact command that show the difference, e.g. `colossalai run --nproc_per_node 8 bench.py --plugin hybrid --tp 2`.
+      If you cannot share code, describe the model, plugin, parallel sizes and batch size.
+    render: python
+  validations:
+    required: true
+
+- type: textarea
+  id: logs
+  attributes:
+    label: Logs
+    description: Relevant logs from both versions, or the traceback for a functionality regression.
+    render: shell
+
+- type: input
+  id: hardware
+  attributes:
+    label: Accelerator model, number of devices and nodes
+    description: GPU, NPU or other accelerator.
+    placeholder: e.g. 8 x H100 80GB, 2 nodes; or 16 x Ascend 910B2, 2 nodes
+  validations:
+    required: true
+
+- type: dropdown
+  id: plugin
+  attributes:
+    label: Booster plugin
+    options:
+      - TorchDDPPlugin
+      - LowLevelZeroPlugin
+      - GeminiPlugin
+      - HybridParallelPlugin
+      - MoeHybridParallelPlugin
+      - TorchFSDPPlugin
+      - Other / not applicable
+
+- type: input
+  id: parallel_config
+  attributes:
+    label: Parallel configuration
+    placeholder: e.g. tp_size=2, pp_size=2, sp_size=1, ep_size=1, zero_stage=1
+
+- type: markdown
+  attributes:
+    value: >
+      Thanks for contributing!