Skip to content

Commit 7176e2e

Browse files
committed
Migrate to issue forms
1 parent 431aea2 commit 7176e2e

File tree

7 files changed

+172
-256
lines changed

7 files changed

+172
-256
lines changed

ISSUE_TEMPLATE/0-core-bug.yml

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

ISSUE_TEMPLATE/1-docs-bug.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: '📃 Documentation Issue'
2+
description: Report an issue with Mithril.js's documentation
3+
assignees: dead-claudia
4+
labels:
5+
- 'Type: Bug'
6+
- 'Area: Documentation'
7+
body:
8+
- type: checkboxes
9+
attributes:
10+
label: Is there an existing issue for this?
11+
description: Please search to see if an issue already exists for the bug you encountered.
12+
options:
13+
- label: I have searched the existing issues
14+
required: true
15+
- type: input
16+
attributes:
17+
label: Offending URL
18+
description: Provide a link to the page with the issue
19+
placeholder: https://mithril.js.org/
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Issue description
25+
description: What is the precise issue with it. Please be specific.
26+
validations:
27+
required: true

ISSUE_TEMPLATE/bug.md

Lines changed: 0 additions & 102 deletions
This file was deleted.

ISSUE_TEMPLATE/config.yml

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: ℹ Questions, Ideas, and Discussions
4+
url: https://github.com/MithrilJS/mithril.js/discussions
5+
about: |
6+
Got a question on how to use Mithril.js? Have a fancy idea of how we could do better? Check
7+
out our discussions forum!
8+
- name: ℹ Show and Tell
9+
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=show-and-tell
10+
about: |
11+
Got something to show off? Made something so cool, you just have to tell the world? Let us
12+
know here in our discussions forum!
13+
- name: 🚀 Feature Request or Enhancement
14+
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=ideas
15+
about: Got a feature request? Let us know here! We do those in our discussion forum.
16+
- name: 💻 Zulip Chat
17+
url: https://mithril.zulipchat.com/
18+
about: Not sure about something? Just want to hang out? Come over to our Zulip chat!

ISSUE_TEMPLATE/feature-or-enhancement.md

Lines changed: 0 additions & 72 deletions
This file was deleted.

0 commit comments

Comments
 (0)