Revise issue templates
This commit is contained in:
parent
dcb992071f
commit
436634b1fe
3 changed files with 117 additions and 2 deletions
|
|
@ -2,7 +2,6 @@ name: '📃 Documentation Issue'
|
||||||
description: Report an issue with Mithril.js's documentation
|
description: Report an issue with Mithril.js's documentation
|
||||||
assignees: dead-claudia
|
assignees: dead-claudia
|
||||||
labels:
|
labels:
|
||||||
- 'Type: Bug'
|
|
||||||
- 'Area: Documentation'
|
- 'Area: Documentation'
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
|
|
@ -2,7 +2,6 @@ name: '🐛 Framework Bug'
|
||||||
description: Report a bug in Mithril.js core
|
description: Report a bug in Mithril.js core
|
||||||
assignees: dead-claudia
|
assignees: dead-claudia
|
||||||
labels:
|
labels:
|
||||||
- 'Type: Bug'
|
|
||||||
- 'Area: Core'
|
- 'Area: Core'
|
||||||
body:
|
body:
|
||||||
- type: checkboxes
|
- type: checkboxes
|
||||||
117
.github/ISSUE_TEMPLATE/2-stream.yml
vendored
Normal file
117
.github/ISSUE_TEMPLATE/2-stream.yml
vendored
Normal file
|
|
@ -0,0 +1,117 @@
|
||||||
|
name: '🌊 Mithril.js Streams bug'
|
||||||
|
description: Report an issue with Mithril.js's Streams module
|
||||||
|
assignees: dead-claudia
|
||||||
|
labels:
|
||||||
|
- 'Area: Stream'
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
attributes:
|
||||||
|
label: Is there an existing issue for this?
|
||||||
|
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
|
||||||
|
- type: input
|
||||||
|
attributes:
|
||||||
|
label: Mithril.js Version
|
||||||
|
description: |
|
||||||
|
Provide the exact version of Mithril.js you're experiencing these issues with. This
|
||||||
|
matters, even if it's really old like version 0.1.0. Do note that bugs in older
|
||||||
|
versions are commonly fixed in newer versions, so you should try to test it
|
||||||
|
against the latest version if you can.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Browser and OS
|
||||||
|
description: |
|
||||||
|
Provide the name and version of both the browser and operating system you're
|
||||||
|
experiencing these issues with. If it's multiple, feel free to list multiple.
|
||||||
|
This matters, even if it's super ancient.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Project
|
||||||
|
description: |
|
||||||
|
(Optional) Provide a link to your project, if it happens to be open source or if
|
||||||
|
you created a repo somewhere that we can look into further. If it's spread across
|
||||||
|
multiple repos or projects, feel free to list them all.
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Code
|
||||||
|
description: |
|
||||||
|
What did you try? What code is causing the unexpected behavior? Make sure to
|
||||||
|
try to reduce your code as best as you can while still reproducing the bug, so
|
||||||
|
we can more accurately determine the cause. Ideally, it should just be a bunch
|
||||||
|
of Mithril.js calls with virtually no logic at all, but it's sufficient to just
|
||||||
|
remove unrelated network calls, attributes, and the like.
|
||||||
|
|
||||||
|
In addition, make sure the bug still persists with the latest version of
|
||||||
|
Mithril. If it's an older version, the bug may have already been fixed.
|
||||||
|
|
||||||
|
If you'd prefer, replace this code block with a link to a code playground like
|
||||||
|
any of these:
|
||||||
|
|
||||||
|
- Flems <https://flems.io/mithril> (stores everything in URL hash)
|
||||||
|
- JSFiddle <https://jsfiddle.net>
|
||||||
|
- CodePen <https://codepen.io>
|
||||||
|
- JSBin <https://jsbin.com>
|
||||||
|
- Plunker <https://plnkr.co>
|
||||||
|
- Glitch <https://glitch.com> (supports backend)
|
||||||
|
- CodeSandbox <https://codesandbox.io> (supports backend)
|
||||||
|
|
||||||
|
Or if it's a remote development project on your own server, feel free to provide
|
||||||
|
that if it's serving unminified code we can look at.
|
||||||
|
|
||||||
|
If it's a closed-source repo, it's okay to censor names and pull out irrelevant
|
||||||
|
logic - we'd rather not sign NDAs just to see the code you're having trouble
|
||||||
|
with. We do still need code of some kind that triggers the bug you're running
|
||||||
|
into.
|
||||||
|
render: javascript
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: |
|
||||||
|
What steps need to be taken to reproduce this behavior? Please include things
|
||||||
|
like specific data that need typed in, specific buttons that need clicked, and
|
||||||
|
so on.
|
||||||
|
placeholder: |
|
||||||
|
1.
|
||||||
|
2.
|
||||||
|
3.
|
||||||
|
4.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Expected Behavior
|
||||||
|
description: |
|
||||||
|
What did you expect to happen?
|
||||||
|
|
||||||
|
- An alert to pop up?
|
||||||
|
- A specific thing to be logged?
|
||||||
|
|
||||||
|
Please be very specific here.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Observed Behavior
|
||||||
|
description: |
|
||||||
|
What actually happened?
|
||||||
|
|
||||||
|
- The alert never showed?
|
||||||
|
- The wrong thing was logged?
|
||||||
|
|
||||||
|
Please be very specific here.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Context
|
||||||
|
description: |
|
||||||
|
(Optional) How is this issue affecting you? What are you trying to do? Providing
|
||||||
|
us context helps us reach a solution that best fits your particular needs.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue