Skip to content

Commit

Permalink
chore/refactor: rework issue_templates (#220)
Browse files Browse the repository at this point in the history
  • Loading branch information
piyoki authored Aug 9, 2023
1 parent 1e578f9 commit a8f14e5
Show file tree
Hide file tree
Showing 10 changed files with 277 additions and 71 deletions.
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/bug-report.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -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:
- **Daed 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: |
- **Daed 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
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
blank_issues_enabled: true
contact_links:
- name: '📚 Support/Q&A'
url: https://github.com/daeuniverse/daed/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: '💬 daed Documentation Link'
url: https://github.com/daeuniverse/daed/blob/main/docs/getting-started.md
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 changes: 0 additions & 11 deletions .github/ISSUE_TEMPLATE/enhancement.md

This file was deleted.

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Enhancement
description: suggest an enhancement to the daed 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 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature-request.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature Request
description: feature request related to daed
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 daed project, feel free to elaborate here.
You may also post your idea on the [Discussions](https://github.com/daeuniverse/daed/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 daed 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
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
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 daed 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 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/support-request.md

This file was deleted.

76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/support-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
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:
- **Daed 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: |
- **Daed 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

0 comments on commit a8f14e5

Please sign in to comment.