Unverified Commit 3a61d785 authored by binmakeswell's avatar binmakeswell Committed by GitHub
Browse files

add doc issue template (#133)

parent 9ef05ed1
...@@ -12,18 +12,14 @@ body: ...@@ -12,18 +12,14 @@ body:
description: | description: |
**Describe the bug** **Describe the bug**
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
**To Reproduce** **To Reproduce**
Steps or code snippet to reproduce the behavior: Steps or code snippet to reproduce the behavior.
**Expected behavior** **Expected behavior**
A clear and concise description of what you expected to happen. A clear and concise description of what you expected to happen.
**Screenshots** **Screenshots**
If applicable, add screenshots to help explain your problem. If applicable, add screenshots to help explain your problem.
placeholder: | placeholder: |
A clear and concise description of what the bug is. A clear and concise description of what the bug is.
validations: validations:
required: true required: true
- type: textarea - type: textarea
...@@ -31,13 +27,7 @@ body: ...@@ -31,13 +27,7 @@ body:
label: Environment label: Environment
description: | description: |
Please provide the environment information, eg. CUDA/cuDNN/NCCL/Python/PyTorch version. 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 - type: markdown
attributes: attributes:
value: > value: >
......
name: 📚 Documentation
description: Report an issue related to https://www.colossalai.org/
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: 📚 The doc issue
description: |
**Description** What content in [Documentation](https://www.colossalai.org/) is an issue?
**Location** Where is the issue location?
**Expectation** What is your expected content about it?
**Screenshots** If applicable, add screenshots to help explain your problem.
**Suggestions** Tell us how we could improve the documentation.
placeholder: |
A clear and concise description of the issue.
validations:
required: true
- type: markdown
attributes:
value: >
Thanks for contributing 🎉!
...@@ -9,25 +9,22 @@ body: ...@@ -9,25 +9,22 @@ body:
- type: textarea - type: textarea
attributes: attributes:
label: Describe the feature label: Describe the feature
description: > 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 [...] **Is your feature request related to a problem? Please describe.**
validations: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
required: true **Describe the solution you'd like**
- type: textarea
attributes:
label: Describe the solution you'd like
description: >
A clear and concise description of what you want to happen. A clear and concise description of what you want to happen.
- type: textarea **Describe alternatives you've considered**
attributes:
label: Describe alternatives you've considered
description: >
A clear and concise description of any alternative solutions or features you've considered. A clear and concise description of any alternative solutions or features you've considered.
- type: textarea **Screenshots**
attributes: If applicable, add screenshots to help explain your problem.
label: Additional context **Suggest a potential alternative/fix**
description: > Tell us how we could improve this project.
Add any other context or screenshots about the feature request here. placeholder: |
A clear and concise description of your idea.
validations:
required: true
- type: markdown - type: markdown
attributes: attributes:
value: > value: >
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment