mirrors/dae
1
0
Fork 0
mirror of https://github.com/daeuniverse/dae.git synced 2025-03-11 18:39:56 +07:00
Code Issues Packages Projects Releases Wiki Activity

chore/refactor: rework issue_templates (#267)

Browse Source
This commit is contained in:
kev 2023-08-09 14:49:36 +08:00 committed by GitHub
parent 054f569c2f
commit ad276de085
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 275 additions and 71 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
.github/ISSUE_TEMPLATE/bug-report.md vendored
View File

@ -1,24 +0,0 @@
---
name: Bug Report
about: Report a bug encountered while operating Dae
labels: kind/bug
---
<!--
Please use this template while reporting a bug and provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. Thanks!
-->
## What happened
## What you expected to happen
## How to reproduce it (as minimally and precisely as possible):
## Anything else we need to know
## Environment
- Dae version (use `dae --version`):
- OS (e.g `cat /etc/os-release`):
- Kernel (e.g. `uname -a`):
- Others:

69
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,69 @@
name: Bug Report
description: report any bugs
title: '[Bug Report] <title>'
labels: [topic/bug]
body:
- type: checkboxes
attributes:
label: Checks
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- label: I have read the documentation
required: true
- label: Is it your first time sumbitting an issue
required: true
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps to Reproduce
description: Steps to reproduce it (as minimally and precisely as possible).
placeholder: |
1. In this environment...
2. With this config...
3. Do ...
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **Dae version (use `dae --version`)**: v0.2.4
- **OS (e.g `cat /etc/os-release`)**: Debian 12
- **Kernel (e.g. `uname -a`)**: 6.4.8-arch1-1
- **Others**: NA
value: |
- **Dae version (use `dae --version`)**:
- **OS (e.g `cat /etc/os-release`)**:
- **Kernel (e.g. `uname -a`)**:
- **Others**:
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Config? Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false

22
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,22 @@
blank_issues_enabled: true
contact_links:
- name: '📚 Support/Q&A'
url: https://github.com/daeuniverse/dae/discussions/categories/q-a-support
about: >-
Some questions are already answered in our github discussions Q&A section If you don't find an answer, [create a support ticket](https://github.com/daeuniverse/dae/discussions/new?category=q-a-support)
- name: '💬 dae Documentation Link (en)'
url: https://github.com/daeuniverse/dae/tree/main/docs/en
about: 'daeuniverse Documentation Link'
- name: '💬 dae Documentation Link (zh)'
url: https://github.com/daeuniverse/dae/tree/main/docs/zh
about: 'daeuniverse Documentation Link'
- name: '💬 daeuniverse Telegram Support'
url: https://t.me/daeuniverse
about: 'daeuniverse Telegram Support Channel'
- name: '💬 daeuniverse GitHub Discussion Support'
url: https://github.com/daeuniverse/dae/discussions
about: 'daeuniverse GitHub Discussion Portal'

11
.github/ISSUE_TEMPLATE/enhancement.md vendored
View File

@ -1,11 +0,0 @@
---
name: Enhancement Request
about: Suggest an enhancement to the Dae project
labels: kind/enhancement
---
<!-- Please only use this template for submitting enhancement requests -->
## What would you like us to improve
## Why is this needed

18
.github/ISSUE_TEMPLATE/enhancement.yml vendored Normal file
View File

@ -0,0 +1,18 @@
name: Enhancement
description: suggest an enhancement to the dae project
title: '[Enhancement] <title>'
labels: [topic/enhancement]
body:
- type: textarea
attributes:
label: Improvement Suggestion
description: What would you like us to improve.
validations:
required: false
- type: textarea
attributes:
label: Potential Benefits
description: Why is this needed.
validations:
required: false

19
.github/ISSUE_TEMPLATE/feature-request.md vendored
View File

@ -1,19 +0,0 @@
---
name: Feature Request
about: feature request related to Dae
labels: kind/feature
---
<!--
STOP -- PLEASE READ!
If you have a good idea that wishes us to integrate to the current dae project, feel free to elaborate here.
You may also post your idea on the Discussions or the Dae Telegram channel (https://t.me/daeuniverse).
-->
<!-- Please only use this template for submitting enhancement requests -->
## What feature you would like us to integrate into the dae project
## Why is this needed

42
.github/ISSUE_TEMPLATE/feature-request.yml vendored Normal file
View File

@ -0,0 +1,42 @@
name: Feature Request
description: feature request related to dae
title: '[Feature Request] <title>'
labels: ['topic/feature']
body:
- type: textarea
attributes:
label: Greetings
description: general greetings
placeholder: |
Thanks for supporting the @daeuniverse community! If you have a good idea that wishes us to integrate to the current dae project, feel free to elaborate here.
You may also post your idea on the [Discussions](https://github.com/daeuniverse/dae/discussions) or the daeuniverse Telegram channel (https://t.me/daeuniverse)
Prior to opening a feature request, please search for existing requests.
If you find an existing feature that matches your needs, use the 👍 emoji to show your support for it. If the specifics of your use case are not covered in the existing feature request but the idea seems similar enough, please take the time to *add new conversation* which helps the feature's design evolve.
If you do not find any other existing requests for the feature you desire, you should open a new feature request. Please take the time to help us understand your use-case as precisely as possible. Be sure to demonstrate that you've evaluated existing features and found them unsuitable.
validations:
required: false
- type: textarea
attributes:
label: Feature Request
description: What feature you would like us to integrate into the dae project.
validations:
required: false
- type: textarea
attributes:
label: Use Cases
description: Share with us what use cases the proposed new feature is categorized to.
validations:
required: false
- type: textarea
attributes:
label: Potential Benefits
description: Why is this needed.
validations:
required: false

47
.github/ISSUE_TEMPLATE/proposal.yml vendored Normal file
View File

@ -0,0 +1,47 @@
name: Proposal
description: new feature proposal (developer only)
title: '[Proposal] <title>'
labels: ['topic/proposal']
body:
- type: textarea
attributes:
label: Proposal
description: What new feature you would like to integrate into the dae project.
validations:
required: false
- type: textarea
attributes:
label: Use Cases
description: What use cases the proposed new feature is categorized to.
validations:
required: false
- type: textarea
attributes:
label: Potential Benefits
description: Why is this needed.
validations:
required: false
- type: textarea
attributes:
label: Scope
description: What needs to be done.
validations:
required: false
- type: textarea
attributes:
label: Reference
description: Useful links
validations:
required: false
- type: textarea
attributes:
label: Implementation
description: PR links to this issue.
validations:
required: false

17
.github/ISSUE_TEMPLATE/support-request.md vendored
View File

@ -1,17 +0,0 @@
---
name: Support Request
about: Support request related to Dae
labels: kind/support
---
<!--
STOP -- PLEASE READ!
GitHub issue is not the right place for support requests.
If you're looking for help, check the Discussions (https://github.com/daeuniverse/dae/discussions).
You can also post your question on the Discussions or the Dae Telegram channel (https://t.me/daeuniverse).
-->
## What would you like us to support (In short summary)

77
.github/ISSUE_TEMPLATE/support-request.yml vendored Normal file
View File

@ -0,0 +1,77 @@
name: Support Request
description: need some help from the community
title: '[Support Request] <title>'
labels: [topic/support]
body:
- type: checkboxes
attributes:
label: Checks
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- label: I have read the documentation
required: true
- label: Is it your first time sumbitting an issue
required: true
- type: textarea
attributes:
label: Support Request
description: What would you like us to support (In short summary).
validations:
required: false
- type: textarea
attributes:
label: Current Behavior
description: A concise description of what you're experiencing.
validations:
required: false
- type: textarea
attributes:
label: Expected Behavior
description: A concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: Steps to Reproduce
description: Steps to reproduce it (as minimally and precisely as possible).
placeholder: |
1. In this environment...
2. With this config...
3. Do ...
4. See error...
validations:
required: false
- type: textarea
attributes:
label: Environment
description: |
examples:
- **Dae version (use `dae --version`)**: v0.2.4
- **OS (e.g `cat /etc/os-release`)**: Debian 12
- **Kernel (e.g. `uname -a`)**: 6.4.8-arch1-1
- **Others**: NA
value: |
- **Dae version (use `dae --version`)**:
- **OS (e.g `cat /etc/os-release`)**:
- **Kernel (e.g. `uname -a`)**:
- **Others**:
validations:
required: false
- type: textarea
attributes:
label: Anything else?
description: |
Config? Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false