Migrate to issue forms
This commit is contained in:
parent
8673cd987d
commit
dcb992071f
7 changed files with 172 additions and 256 deletions
118
.github/ISSUE_TEMPLATE/0-core-bug.yml
vendored
Normal file
118
.github/ISSUE_TEMPLATE/0-core-bug.yml
vendored
Normal file
|
|
@ -0,0 +1,118 @@
|
||||||
|
name: '🐛 Framework Bug'
|
||||||
|
description: Report a bug in Mithril.js core
|
||||||
|
assignees: dead-claudia
|
||||||
|
labels:
|
||||||
|
- 'Type: Bug'
|
||||||
|
- 'Area: Core'
|
||||||
|
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.
|
||||||
27
.github/ISSUE_TEMPLATE/1-docs-bug.yml
vendored
Normal file
27
.github/ISSUE_TEMPLATE/1-docs-bug.yml
vendored
Normal file
|
|
@ -0,0 +1,27 @@
|
||||||
|
name: '📃 Documentation Issue'
|
||||||
|
description: Report an issue with Mithril.js's documentation
|
||||||
|
assignees: dead-claudia
|
||||||
|
labels:
|
||||||
|
- 'Type: Bug'
|
||||||
|
- 'Area: Documentation'
|
||||||
|
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: Offending URL
|
||||||
|
description: Provide a link to the page with the issue
|
||||||
|
placeholder: https://mithril.js.org/
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
attributes:
|
||||||
|
label: Issue description
|
||||||
|
description: What is the precise issue with it. Please be specific.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
102
.github/ISSUE_TEMPLATE/bug.md
vendored
102
.github/ISSUE_TEMPLATE/bug.md
vendored
|
|
@ -1,102 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F41B Bug"
|
|
||||||
about: Report a bug in Mithril.js
|
|
||||||
title: ''
|
|
||||||
labels: 'Type: Bug'
|
|
||||||
assignees: dead-claudia
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Provide a general summary of your issue in the "Title" above -->
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
**Mithril.js 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.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.
|
|
||||||
-->
|
|
||||||
```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.
|
|
||||||
-->
|
|
||||||
18
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
18
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
blank_issues_enabled: true
|
||||||
|
contact_links:
|
||||||
|
- name: ℹ Questions, Ideas, and Discussions
|
||||||
|
url: https://github.com/MithrilJS/mithril.js/discussions
|
||||||
|
about: |
|
||||||
|
Got a question on how to use Mithril.js? Have a fancy idea of how we could do better? Check
|
||||||
|
out our discussions forum!
|
||||||
|
- name: ℹ Show and Tell
|
||||||
|
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=show-and-tell
|
||||||
|
about: |
|
||||||
|
Got something to show off? Made something so cool, you just have to tell the world? Let us
|
||||||
|
know here in our discussions forum!
|
||||||
|
- name: 🚀 Feature Request or Enhancement
|
||||||
|
url: https://github.com/MithrilJS/mithril.js/discussions/new?category=ideas
|
||||||
|
about: Got a feature request? Let us know here! We do those in our discussion forum.
|
||||||
|
- name: 💻 Zulip Chat
|
||||||
|
url: https://mithril.zulipchat.com/
|
||||||
|
about: Not sure about something? Just want to hang out? Come over to our Zulip chat!
|
||||||
72
.github/ISSUE_TEMPLATE/feature-or-enhancement.md
vendored
72
.github/ISSUE_TEMPLATE/feature-or-enhancement.md
vendored
|
|
@ -1,72 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F680 Feature or Enhancement"
|
|
||||||
about: Suggest an idea or feature for Mithril.js
|
|
||||||
title: ''
|
|
||||||
labels: 'Type: Enhancement'
|
|
||||||
assignees: dead-claudia
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Provide a general summary of your suggestion in the "Title" above -->
|
|
||||||
<!--
|
|
||||||
Optional: Provide the exact version of Mithril.js 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
|
|
||||||
are much more actively maintained than older versions, so it's unlikely we'll
|
|
||||||
add new features to older versions like 0.1.x.
|
|
||||||
-->
|
|
||||||
**Mithril.js version:**
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Optional: Provide the name and version of both the platform (Chrome, Node, etc.)
|
|
||||||
and operating system you're running Mithril.js 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.
|
|
||||||
-->
|
|
||||||
**Platform 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.
|
|
||||||
-->
|
|
||||||
82
.github/ISSUE_TEMPLATE/question.md
vendored
82
.github/ISSUE_TEMPLATE/question.md
vendored
|
|
@ -1,82 +0,0 @@
|
||||||
---
|
|
||||||
name: "\U0001F64B♀️ Question"
|
|
||||||
about: Ask a question about Mithril.js
|
|
||||||
title: ''
|
|
||||||
labels: 'Type: Question'
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!-- Provide a general summary of your question in the "Title" above -->
|
|
||||||
<!--
|
|
||||||
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.
|
|
||||||
-->
|
|
||||||
**Mithril.js 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.
|
|
||||||
-->
|
|
||||||
9
.github/workflows/issue-create.yml
vendored
9
.github/workflows/issue-create.yml
vendored
|
|
@ -4,7 +4,16 @@ on:
|
||||||
types: [opened]
|
types: [opened]
|
||||||
permissions:
|
permissions:
|
||||||
issues: write
|
issues: write
|
||||||
|
repository-projects: write
|
||||||
jobs:
|
jobs:
|
||||||
|
add_triage:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- run: gh issue edit "$ISSUE_URL" --add-project 'Triage/bugs'
|
||||||
|
env:
|
||||||
|
ISSUE_URL: ${{ github.event.issue.url }}
|
||||||
|
GITHUB_TOKEN: ${{ github.token }}
|
||||||
|
|
||||||
notify:
|
notify:
|
||||||
uses: ./.github/workflows/_post-comment.yml
|
uses: ./.github/workflows/_post-comment.yml
|
||||||
with:
|
with:
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue