From 43e7d54643f422badb42e2deb33bfd06ccd4ecf9 Mon Sep 17 00:00:00 2001 From: binmakeswell Date: Thu, 6 Jan 2022 16:13:34 +0800 Subject: [PATCH] fix issue template (#118) --- .github/ISSUE_TEMPLATE/bug-report.yml | 44 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/bug_report.md | 30 --------------- .github/ISSUE_TEMPLATE/feature_request.md | 20 ---------- .github/ISSUE_TEMPLATE/feature_request.yml | 34 +++++++++++++++++ 4 files changed, 78 insertions(+), 50 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..488353a2a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,44 @@ +name: 🐛 Bug Report +description: Create a report to help us reproduce and fix the bug + +body: +- type: markdown + attributes: + value: > + #### Not suitable for your needs? [Open a blank issue](https://github.com/hpcaitech/ColossalAI/issues/new). +- type: textarea + attributes: + 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** + If applicable, add screenshots to help explain your problem. + placeholder: | + A clear and concise description of what the bug is. + + validations: + required: true +- type: textarea + attributes: + label: Environment + description: | + Please provide the environment information, eg. CUDA/cuDNN/NCCL/Python/PyTorch version. + validations: + required: true +- type: textarea + attributes: + label: Additional context + description: > + Add any other context or screenshots about the feature request here. +- type: markdown + attributes: + value: > + Thanks for contributing 🎉! diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5be3894b9..000000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**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** -If applicable, add screenshots to help explain your problem. - -**Environment (please complete the following information):** - - CUDA version: - - cuDNN version: - - NCCL version: - - Python version: - - PyTorch version: - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f45586549..000000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "[FEATURE]" -labels: enhancement -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..432060c98 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,34 @@ +name: 🚀 Feature request +description: Suggest an idea for this project + +body: +- type: markdown + attributes: + value: > + #### Not suitable for your needs? [Open a blank issue](https://github.com/hpcaitech/ColossalAI/issues/new). +- type: textarea + attributes: + label: Describe the feature + description: > + Is your feature request related to a problem? Please provide a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: > + A clear and concise description of what you want to happen. +- type: textarea + attributes: + label: Describe alternatives you've considered + description: > + A clear and concise description of any alternative solutions or features you've considered. +- type: textarea + attributes: + label: Additional context + description: > + Add any other context or screenshots about the feature request here. +- type: markdown + attributes: + value: > + Thanks for contributing 🎉!