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

@ -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.
-->