Update issue templates

Update issue templates to be a lot clearer on what we want.
This commit is contained in:
Isiah Meadows 2019-07-12 03:57:15 -04:00 committed by GitHub
parent 904b63b2aa
commit 9900e427fd
7 changed files with 576 additions and 41 deletions

View file

@ -0,0 +1,82 @@
---
name: "\U0001F64B Question"
about: Ask a question about Mithril
title: ''
labels: question
assignees: ''
---
<!-- Provide a general summary of your question in the "Title" above -->
<!--
Provide the exact version of Mithril you're experiencing these issues with. This
matters, even if it's really old like version 0.1.0.
-->
**Mithril version:**
<!--
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 like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
## Code
<!--
What did you try? Please be specific here. 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.
-->
```javascript
// Code
```
## Expected Behavior
<!--
What did you expect to happen?
- An alert to pop up?
- A specific thing to be logged?
-->
## Current Behavior
<!--
What actually happened?
- The alert never showed?
- The wrong thing was logged?
-->
## Steps to Reproduce
<!--
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.
-->
1.
2.
3.
4.
## Context
<!--
How is this issue affecting you? What are you trying to do? Providing us context
helps us reach a conclusion that best fits your particular needs.
-->

82
.github/ISSUE_TEMPLATE/-----question.md vendored Normal file
View file

@ -0,0 +1,82 @@
---
name: "\U0001F64BQuestion"
about: Ask a question about Mithril
title: ''
labels: question
assignees: ''
---
<!-- Provide a general summary of your question in the "Title" above -->
<!--
Provide the exact version of Mithril you're experiencing these issues with. This
matters, even if it's really old like version 0.1.0.
-->
**Mithril version:**
<!--
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 like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
## Code
<!--
What did you try? Please be specific here. 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.
-->
```javascript
// Code
```
## Expected Behavior
<!--
What did you expect to happen?
- An alert to pop up?
- A specific thing to be logged?
-->
## Current Behavior
<!--
What actually happened?
- The alert never showed?
- The wrong thing was logged?
-->
## Steps to Reproduce
<!--
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.
-->
1.
2.
3.
4.
## Context
<!--
How is this issue affecting you? What are you trying to do? Providing us context
helps us reach a conclusion that best fits your particular needs.
-->

102
.github/ISSUE_TEMPLATE/---bug.md vendored Normal file
View file

@ -0,0 +1,102 @@
---
name: "\U0001F41B Bug"
about: Report a bug in Mithril
title: ''
labels: bug
assignees: isiahmeadows
---
<!-- Provide a general summary of your issue in the "Title" above -->
<!--
Provide the exact version of Mithril 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.
-->
**Mithril version:**
<!--
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 like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
## Code
<!--
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 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.
-->
```javascript
// Code
```
## Steps to Reproduce
<!--
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.
-->
1.
2.
3.
4.
## Expected Behavior
<!--
What did you expect to happen?
- An alert to pop up?
- A specific thing to be logged?
Please be very specific here.
-->
## Current Behavior
<!--
What actually happened?
- The alert never showed?
- The wrong thing was logged?
Please be very specific here.
-->
## Context
<!--
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.
-->

View file

@ -0,0 +1,71 @@
---
name: "\U0001F680 Feature or Enhancement"
about: Suggest an idea or feature for Mithril
title: ''
labels: enhancement
assignees: isiahmeadows
---
<!-- Provide a general summary of your suggestion in the "Title" above -->
<!--
Optional: Provide the exact version of Mithril you're experiencing issues with.
This could matter, even if it's really old like version 0.1.0. Do note that bugs
in older versions are commonly fixed in newer versions and that newer versions
do end up with a lot more features than older versions, so it's unlikely we'll
add new features to older versions like 0.1.x.
-->
**Mithril version:**
<!--
Optional: Provide the name and version of both the browser and operating system
you're running Mithril on. If it's multiple, feel free to list multiple. This
could matter, even if it's super ancient like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
<!-- Required -->
**Is this something you're interested in implementing yourself?**
### Description
<!--
What exactly are you suggesting? Is it a particular missing feature? An odd
design choice you think could be improved? This doesn't need to be a concrete,
fully-fledged proposal, but it does need to be clear - it's hard to act on
suggestions that are too vague or generic.
-->
### Why
<!--
Why is this important to you? How would you use it? We need to know what
problems it would solve in the real world and what benefits it would bring, for
both you and other potential users, so we know how we should prioritize it and
so we can see if a better solution might exist.
-->
### Possible Implementation
<!--
Optional: How might this be implemented? This is optional, but it helps us put
the size and cost of the feature into perspective. Simpler features to implement
can often be justified by just being helpful, but big, complex features could
require a massive benefit to pay for their size, scale, and complexity.
(This is why the discussion on a context API similar to React's got so
contentious - it's right on that line where it could go either way on the
cost/benefit ratio for us.)
-->
### Open Questions
<!--
Optional: What things still need discussed? If there are certain details you
aren't sure about, this could help inform discussion. Open questions like these
are precisely what shaped our sync vs async redraw API to be what they are for
v2.
-->

102
.github/ISSUE_TEMPLATE/--bug.md vendored Normal file
View file

@ -0,0 +1,102 @@
---
name: "\U0001F41BBug"
about: Report a bug in Mithril
title: ''
labels: bug
assignees: isiahmeadows
---
<!-- Provide a general summary of your issue in the "Title" above -->
<!--
Provide the exact version of Mithril 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.
-->
**Mithril version:**
<!--
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 like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
## Code
<!--
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 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.
-->
```javascript
// Code
```
## Steps to Reproduce
<!--
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.
-->
1.
2.
3.
4.
## Expected Behavior
<!--
What did you expect to happen?
- An alert to pop up?
- A specific thing to be logged?
Please be very specific here.
-->
## Current Behavior
<!--
What actually happened?
- The alert never showed?
- The wrong thing was logged?
Please be very specific here.
-->
## Context
<!--
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.
-->

View file

@ -1,49 +1,102 @@
---
name: "\U0001F41BBug report"
about: Report a bug in MithrilJS
about: Report a bug in Mithril
title: ''
labels: bug
assignees: isiahmeadows
---
### Mithril Version: x.x.x
<!-- Provide a general summary of your issue in the "Title" above -->
<!--
Provide the exact version of Mithril 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.
-->
**Mithril version:**
<!--- Provide the exact version of MithrilJS in which you see the bug. -->
<!--
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 like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
<!--- Provide a general summary of the issue in the Title above -->
## Code
<!--
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 calls with virtually no logic at all, but it's sufficient to just
remove unrelated network calls, attributes, and the like.
## Expected Behavior
<!--- If you're describing a bug, tell us what should happen -->
<!--- If you're suggesting a change/improvement, tell us how it should work -->
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.
## Current Behavior
<!--- If describing a bug, tell us what happens instead of the expected behavior -->
<!--- If suggesting a change/improvement, explain the difference from current behavior -->
If you'd prefer, replace this code block with a link to a code playground like
any of these:
## Possible Solution
<!--- Not obligatory, but suggest a fix/reason for the bug, -->
<!--- or ideas how to implement the addition or change -->
- 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.
-->
```javascript
// Code
```
## Steps to Reproduce
<!--- Provide a link to a live example, or an unambiguous set of steps to -->
<!--- reproduce this bug. Include code to reproduce, if relevant -->
<!--
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.
-->
1.
2.
3.
4.
## Expected Behavior
<!--
What did you expect to happen?
- An alert to pop up?
- A specific thing to be logged?
Please be very specific here.
-->
## Current Behavior
<!--
What actually happened?
- The alert never showed?
- The wrong thing was logged?
Please be very specific here.
-->
## Context
<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->
<details>
<summary>Additional Information</summary>
## Your Environment
<!--- Include as many relevant details about the environment you experienced the bug in -->
* Browser Name and version:
* Operating System and version (desktop or mobile):
* Link to your project:
</details>
<!--
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.
-->

View file

@ -1,28 +1,71 @@
---
name: "\U0001F680Feature or Enhancement"
about: Suggest an Idea or Enhancement for MithrilJS
about: Suggest an idea or feature for Mithril
title: ''
labels: enhancement
assignees: isiahmeadows
---
### Description
<!-- Provide a general summary of your suggestion in the "Title" above -->
<!--
Optional: Provide the exact version of Mithril you're experiencing issues with.
This could matter, even if it's really old like version 0.1.0. Do note that bugs
in older versions are commonly fixed in newer versions and that newer versions
do end up with a lot more features than older versions, so it's unlikely we'll
add new features to older versions like 0.1.x.
-->
**Mithril version:**
<!--- Provide a detailed description of the change or addition you are proposing -->
<!--
Optional: Provide the name and version of both the browser and operating system
you're running Mithril on. If it's multiple, feel free to list multiple. This
could matter, even if it's super ancient like IE 6 on Windows XP.
-->
**Browser and OS:**
<!--
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 multiple
projects, feel free to list them all.
-->
**Project:**
<!-- Required -->
**Is this something you're interested in implementing yourself?**
### Description
<!--
What exactly are you suggesting? Is it a particular missing feature? An odd
design choice you think could be improved? This doesn't need to be a concrete,
fully-fledged proposal, but it does need to be clear - it's hard to act on
suggestions that are too vague or generic.
-->
### Why
<!--
Why is this important to you? How would you use it? We need to know what
problems it would solve in the real world and what benefits it would bring, for
both you and other potential users, so we know how we should prioritize it and
so we can see if a better solution might exist.
-->
<!--- Why is this change important to you? How would you use it? -->
### Possible Implementation
<!--
Optional: How might this be implemented? This is optional, but it helps us put
the size and cost of the feature into perspective. Simpler features to implement
can often be justified by just being helpful, but big, complex features could
require a massive benefit to pay for their size, scale, and complexity.
<!--- How can it benefit other users? -->
(This is why the discussion on a context API similar to React's got so
contentious - it's right on that line where it could go either way on the
cost/benefit ratio for us.)
-->
### Possible Implementation & Open Questions
<!--- Not obligatory, but suggest an idea for implementing addition or change -->
<!--- What still needs to be discussed -->
### Is this something you're interested in working on?
<!--- Yes or no -->
### Open Questions
<!--
Optional: What things still need discussed? If there are certain details you
aren't sure about, this could help inform discussion. Open questions like these
are precisely what shaped our sync vs async redraw API to be what they are for
v2.
-->