mirror of https://github.com/hpcaitech/ColossalAI
add doc issue template (#133)
parent
9ef05ed1fc
commit
3a61d785b5
|
@ -12,18 +12,14 @@ body:
|
|||
description: |
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps or code snippet to reproduce the behavior:
|
||||
|
||||
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
|
||||
|
@ -31,13 +27,7 @@ body:
|
|||
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: >
|
||||
|
|
|
@ -0,0 +1,26 @@
|
|||
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:
|
|||
- 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 [...]
|
||||
description: |
|
||||
**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.
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
**Suggest a potential alternative/fix**
|
||||
Tell us how we could improve this project.
|
||||
placeholder: |
|
||||
A clear and concise description of your idea.
|
||||
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: >
|
||||
|
|
Loading…
Reference in New Issue