Skip to content

Commit 600f3f7

Browse files
committed
Revise issue templates
1 parent 7176e2e commit 600f3f7

File tree

3 files changed

+117
-2
lines changed

3 files changed

+117
-2
lines changed

ISSUE_TEMPLATE/1-docs-bug.yml renamed to ISSUE_TEMPLATE/0-docs.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: '📃 Documentation Issue'
22
description: Report an issue with Mithril.js's documentation
33
assignees: dead-claudia
44
labels:
5-
- 'Type: Bug'
65
- 'Area: Documentation'
76
body:
87
- type: checkboxes

ISSUE_TEMPLATE/0-core-bug.yml renamed to ISSUE_TEMPLATE/1-core.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ name: '🐛 Framework Bug'
22
description: Report a bug in Mithril.js core
33
assignees: dead-claudia
44
labels:
5-
- 'Type: Bug'
65
- 'Area: Core'
76
body:
87
- type: checkboxes

ISSUE_TEMPLATE/2-stream.yml

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
name: '🌊 Mithril.js Streams bug'
2+
description: Report an issue with Mithril.js's Streams module
3+
assignees: dead-claudia
4+
labels:
5+
- 'Area: Stream'
6+
body:
7+
- type: checkboxes
8+
attributes:
9+
label: Is there an existing issue for this?
10+
description: Please search to see if an issue already exists for the bug you encountered.
11+
options:
12+
- label: I have searched the existing issues
13+
required: true
14+
- type: input
15+
attributes:
16+
label: Mithril.js Version
17+
description: |
18+
Provide the exact version of Mithril.js you're experiencing these issues with. This
19+
matters, even if it's really old like version 0.1.0. Do note that bugs in older
20+
versions are commonly fixed in newer versions, so you should try to test it
21+
against the latest version if you can.
22+
validations:
23+
required: true
24+
- type: textarea
25+
attributes:
26+
label: Browser and OS
27+
description: |
28+
Provide the name and version of both the browser and operating system you're
29+
experiencing these issues with. If it's multiple, feel free to list multiple.
30+
This matters, even if it's super ancient.
31+
validations:
32+
required: true
33+
- type: textarea
34+
attributes:
35+
label: Project
36+
description: |
37+
(Optional) Provide a link to your project, if it happens to be open source or if
38+
you created a repo somewhere that we can look into further. If it's spread across
39+
multiple repos or projects, feel free to list them all.
40+
- type: textarea
41+
attributes:
42+
label: Code
43+
description: |
44+
What did you try? What code is causing the unexpected behavior? Make sure to
45+
try to reduce your code as best as you can while still reproducing the bug, so
46+
we can more accurately determine the cause. Ideally, it should just be a bunch
47+
of Mithril.js calls with virtually no logic at all, but it's sufficient to just
48+
remove unrelated network calls, attributes, and the like.
49+
50+
In addition, make sure the bug still persists with the latest version of
51+
Mithril. If it's an older version, the bug may have already been fixed.
52+
53+
If you'd prefer, replace this code block with a link to a code playground like
54+
any of these:
55+
56+
- Flems <https://flems.io/mithril> (stores everything in URL hash)
57+
- JSFiddle <https://jsfiddle.net>
58+
- CodePen <https://codepen.io>
59+
- JSBin <https://jsbin.com>
60+
- Plunker <https://plnkr.co>
61+
- Glitch <https://glitch.com> (supports backend)
62+
- CodeSandbox <https://codesandbox.io> (supports backend)
63+
64+
Or if it's a remote development project on your own server, feel free to provide
65+
that if it's serving unminified code we can look at.
66+
67+
If it's a closed-source repo, it's okay to censor names and pull out irrelevant
68+
logic - we'd rather not sign NDAs just to see the code you're having trouble
69+
with. We do still need code of some kind that triggers the bug you're running
70+
into.
71+
render: javascript
72+
validations:
73+
required: true
74+
- type: textarea
75+
attributes:
76+
label: Steps to Reproduce
77+
description: |
78+
What steps need to be taken to reproduce this behavior? Please include things
79+
like specific data that need typed in, specific buttons that need clicked, and
80+
so on.
81+
placeholder: |
82+
1.
83+
2.
84+
3.
85+
4.
86+
validations:
87+
required: true
88+
- type: textarea
89+
attributes:
90+
label: Expected Behavior
91+
description: |
92+
What did you expect to happen?
93+
94+
- An alert to pop up?
95+
- A specific thing to be logged?
96+
97+
Please be very specific here.
98+
validations:
99+
required: true
100+
- type: textarea
101+
attributes:
102+
label: Observed Behavior
103+
description: |
104+
What actually happened?
105+
106+
- The alert never showed?
107+
- The wrong thing was logged?
108+
109+
Please be very specific here.
110+
validations:
111+
required: true
112+
- type: textarea
113+
attributes:
114+
label: Context
115+
description: |
116+
(Optional) How is this issue affecting you? What are you trying to do? Providing
117+
us context helps us reach a solution that best fits your particular needs.

0 commit comments

Comments
 (0)