Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: revamp issue templates #826

Draft
wants to merge 17 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

50 changes: 50 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Bug Report
description: Something is not working as expected? Let us know how we can fix it.
labels: [ bug, untriaged ]
body:

- type: checkboxes
id: reproducible
attributes:
label: Checklist
options:
- label: This error does NOT cause the app to crash.
required: true
- label: I've already searched in [exising issues](https://github.com/Ashinch/ReadYou/issues?q=is%3Aissue+) and haven't found a similar problem reported.
required: true
- label: This error can be reproduced with the same action, feed or article.

- type: dropdown
id: types
attributes:
label: Which category best fits this error?
options:
- Feed Sync
- Feed Management
- User Interface
- Others
validations:
required: true

- type: input
id: version
attributes:
label: App version
validations:
required: true

- type: textarea
id: repro
attributes:
label: Reproduction steps
description: "How can we reproduce this bug? Please specify the account type (local, Google Reader, etc.) and, if applicable, the link to the relevant feed or article."
value: |
1.
2.
3.
...
render: bash
validations:
required: true


38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/crash_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Crash Report
description: Tell us what happended when the app crashed or stopped working
labels: [ bug, untriaged ]
body:

- type: checkboxes
id: reproducible
attributes:
label: Checklist
options:
- label: This error causes the app to crash.
required: true
- label: This error is consistently reproducible with the same action, feed or article.

- type: textarea
id: report
attributes:
label: Error report
description: "An error report page should appear after the app crashing. Please copy and paste the report here."
render: bash
validations:
required: true

- type: textarea
id: repro
attributes:
label: Reproduction steps
description: "How can we recreate this bug? Please specify the account type (local, Google Reader, etc.) and, if applicable, the link to the relevant feed or article."
value: |
1.
2.
3.
...
render: bash
validations:
required: true


16 changes: 0 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "Feature Request"
description: Suggest a new feature for the app
labels: [ enhancement, untriaged ]
body:

- type: checkboxes
id: checklist
attributes:
label: Checklist
options:
- label: I've already searched in [exising issues](https://github.com/Ashinch/ReadYou/issues?q=is%3Aissue+) and haven't found a similar feature request.
required: true


- type: dropdown
id: types
attributes:
label: Which category best fits this feature request?
options:
- Feed Sync & Management
- User Interface
- New API Integration
- Others
validations:
required: true


- type: textarea
id: description_1
attributes:
label: Is your feature request related to a problem? Please describe.
description:
placeholder: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: description_2
attributes:
label: Describe the solution you'd like
description:
placeholder: A clear and concise description of what you want to happen.
validations:
required: false
- type: textarea
id: description_3
attributes:
label: Related links
description:
placeholder: Please provide links to the feed or article where this feature might be beneficial.
validations:
required: false
Loading