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

[GitHub] Add prefix and label in issue template (#652)

parent 67b49282
name: 🐛 Bug Report name: 🐛 Bug Report
description: Create a report to help us reproduce and fix the bug description: Create a report to help us reproduce and fix the bug
title: "[BUG]: "
labels: [bug]
body: body:
- type: markdown - type: markdown
......
name: 📚 Documentation name: 📚 Documentation
description: Report an issue related to https://www.colossalai.org/ description: Report an issue related to https://www.colossalai.org/
title: "[DOC]: "
labels: [documentation]
body: body:
- type: markdown - type: markdown
......
name: 🚀 Feature request name: 🚀 Feature request
description: Suggest an idea for this project description: Suggest an idea for this project
title: "[FEATURE]: "
labels: [enhancement]
body: body:
- type: markdown - type: markdown
......
name: 💥 Proposal name: 💥 Proposal
description: Propose a non-trivial change to Colossal-AI description: Propose a non-trivial change to Colossal-AI
title: "[PROPOSAL]: "
labels: [enhancement]
body: body:
- type: markdown - type: markdown
attributes: attributes:
value: | value: |
Common reasons for proposals include: Common reasons for proposals include:
- Altering the infrastructure; - Altering the infrastructure;
- Bumping a critical dependency's major version; - Bumping a critical dependency's major version;
- A significant improvement in user-friendliness; - A significant improvement in user-friendliness;
- Significant refactor; - Significant refactor;
- ... - ...
Please note this is not for feature request or bug template; such action could make us identify the issue wrongly and close it without doing anything. Please note this is not for feature request or bug template; such action could make us identify the issue wrongly and close it without doing anything.
We give you maximum freedom to write an elaborated proposal illustrating why you think the change is beneficial for us, and what steps we should take to turn this into reality. We give you maximum freedom to write an elaborated proposal illustrating why you think the change is beneficial for us, and what steps we should take to turn this into reality.
- type: textarea - type: textarea
attributes: attributes:
label: Proposal label: Proposal
description: A clear and concise description of what the proposal is. description: A clear and concise description of what the proposal is.
validations: validations:
required: true required: true
- type: checkboxes - type: checkboxes
attributes: attributes:
label: Self-service label: Self-service
description: | description: |
If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it. If you feel like you could contribute to this issue, please check the box below. This would tell us and other people looking for contributions that someone's working on it.
If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else. If you do check this box, please send a pull request within 7 days after a maintainer's approval so we can still delegate this to someone else.
Proposals usually involve significant code changes, so please reach consensus with the maintainers before rushing to implement it, and make sure you follow the [Contributing Guidelines](https://github.com/hpcaitech/ColossalAI/blob/main/CONTRIBUTING.md). Proposals usually involve significant code changes, so please reach consensus with the maintainers before rushing to implement it, and make sure you follow the [Contributing Guidelines](https://github.com/hpcaitech/ColossalAI/blob/main/CONTRIBUTING.md).
This ensures that you don't waste your time and we don't waste ours reading the large diffs. This ensures that you don't waste your time and we don't waste ours reading the large diffs.
options: options:
- label: I'd be willing to do some initial work on this proposal myself. - label: I'd be willing to do some initial work on this proposal myself.
- type: markdown - type: markdown
......
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