Skip to content

Commit

Permalink
chore: Modify issue template.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed May 25, 2023
1 parent 99b6238 commit e1cae43
Show file tree
Hide file tree
Showing 8 changed files with 168 additions and 108 deletions.
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/Bug_report.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/Feature_request.md

This file was deleted.

27 changes: 0 additions & 27 deletions .github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/NEW_ADDITION_TO_LIST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: 🐝 Addition to list
description: Suggest an addition to this list.
title: '🐝 Add <App Name>'
labels: ['addition']
body:
- type: markdown
attributes:
value: |
NOTE: Each discrete (stand-alone) request should be in its own issue.
- type: textarea
attributes:
label: Provide a link to the proposed addition
description: Place link here.
placeholder: |
https://github.com/jaywcjlove/awesome-mac
https://github.com/jaywcjlove/awesome-mac
https://github.com/jaywcjlove/awesome-mac
validations:
required: true

- type: textarea
attributes:
label: Explain why it should be added
description: A clear and concise description of why it should be added to this list.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.


- type: checkboxes
attributes:
label: 🧨 Issue Checklist
description: Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue.
options:
- label: I have checked for other similar issues
- label: I have explained why this change is important
- label: I have added necessary documentation (if appropriate)
validations:
required: true
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.md

This file was deleted.

32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/REMOVE_ITEM_FROM_LIST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: 🐝 Removal from list
description: Suggest a removal from this list.
title: '🐝 Remove <App Name>'
labels: ['addition']
body:
- type: markdown
attributes:
value: |
NOTE: Each discrete (stand-alone) request should be in its own issue.
- type: textarea
attributes:
label: Provide a link to the proposed addition
description: Place link here.
placeholder: |
https://github.com/jaywcjlove/awesome-mac
https://github.com/jaywcjlove/awesome-mac
https://github.com/jaywcjlove/awesome-mac
validations:
required: true

- type: textarea
attributes:
label: Explain why it should be removed
description: A clear and concise description of why it should be added to this list.
validations:
required: true

- type: textarea
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: 🐞 Bug Report
description: File a report when something goes wrong so it can get fixed!
title: '🐞 Bug Report: xxx.md'
labels: ['bug']
body:
- type: markdown
attributes:
value: |
NOTE: Each discrete (stand-alone) request should be in its own issue.
- type: textarea
attributes:
label: 🐞 Describe the bug
description: A clear and concise description of what the bug is.
placeholder: ex. xxxx
validations:
required: true

- type: markdown
attributes:
value: |
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
- type: textarea
attributes:
label: 📖 Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: ex. xxxx
validations:
required: true

- type: textarea
attributes:
label: 🌅 Screenshots
description: If applicable, add screenshots to help explain your problem.
placeholder: ex. xxxx
validations:
required: true

- type: input
attributes:
label: "💻 Desktop"
placeholder: ex. `MacOS 13.0.1`
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: 🐝 Feature request
description: Suggest a feature for this project
title: '🐝 Feature request'
labels: ['help wanted']
body:
- type: markdown
attributes:
value: |
NOTE: Each discrete (stand-alone) request should be in its own issue.
- type: textarea
attributes:
label: Is your feature request related to a problem? Please describe.
description: A clear and concise description of what the problem is.
placeholder: Ex. I'm always frustrated when [...]
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 contex
description: Add any other context or screenshots about the feature request here.


- type: checkboxes
attributes:
label: 🧨 Issue Checklist
description: Put an x in the boxes once you've completed each step. You can also fill these out after creating the issue. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before responding to the issue.
options:
- label: I have checked for other similar issues
- label: I have explained why this change is important
- label: I have added necessary documentation (if appropriate)
validations:
required: true

0 comments on commit e1cae43

Please sign in to comment.