Skip to content

Commit

Permalink
Improve Issue Templates (cfug#31)
Browse files Browse the repository at this point in the history
  • Loading branch information
ueman authored Dec 15, 2022
1 parent 7ad1240 commit b9a978d
Show file tree
Hide file tree
Showing 5 changed files with 100 additions and 20 deletions.
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: 🐞 Bug Report
description: Tell us about something that's not working the way we (probably) intend.
labels: ["s: bug", "h: need triage"]
body:
- type: markdown
attributes:
value: |
🧐 **Guidelines:**
- Search through [existing issues](https://github.com/cfug/diox/issues) first to ensure that this bug has not been reported before.
- Write a descriptive title for your issue. Avoid generic or vague titles such as "Something's not working" or "A couple of problems".
- Keep your issue focused on one single problem. If you have multiple bug reports, please create separate issues for each of them.
- Provide as much context as possible in the fields below. Include screenshots, screen recordings, links, references, or anything else you may consider relevant.
- If you want to ask a question instead of reporting a bug, please use [discussions](https://github.com/cfug/diox/discussions/new) instead.
- type: dropdown
id: package
attributes:
label: Package
description: Which package has a problem?
options:
- diox
- cookie_manager
- http2_adapter
validations:
required: true
- type: input
id: version
attributes:
label: Version
placeholder: 1.2.3
description: Which version of that package do you use?
validations:
required: true
- type: textarea
id: flutter_info
attributes:
label: Output of `flutter doctor -v`
description: Required when used with Flutter. The input is automatically formatted in code fences
render: shell
- type: input
id: dart_version
attributes:
label: Dart Version
placeholder: 1.2.3
description: Which version of Dart do you use?
validations:
required: false
- type: textarea
id: repro
attributes:
label: Steps to Reproduce
description: How can we see what you're seeing? Specific is terrific.
placeholder: |-
1. foo
2. bar
3. baz
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Result
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Result
description: Logs? Screenshots? Yes, please.
validations:
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 💡 Feature Request
description: Tell us about a problem diox could solve but doesn't.
labels: ["s: feature"]
body:
- type: textarea
id: problem
attributes:
label: Request Statement
description: What problem could diox solve that it doesn't?
validations:
required: true
- type: textarea
id: expected
attributes:
label: Solution Brainstorm
description: We know you have bright ideas to share ... share away, friend.
validations:
required: false
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/infra.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
name: 👷 Infra
description: Something is wrong with the CI setup or could be improved
labels: ["s: infra"]
body:
- type: textarea
id: problem
attributes:
label: Request Statement
validations:
required: true

0 comments on commit b9a978d

Please sign in to comment.