From 9b79e104922c2650da9d4610bff07111e23248f1 Mon Sep 17 00:00:00 2001 From: Claudia Meadows Date: Mon, 2 Sep 2024 13:05:15 -0700 Subject: [PATCH] Revise issue templates --- .../{1-docs-bug.yml => 0-docs.yml} | 1 - .../{0-core-bug.yml => 1-core.yml} | 1 - .github/ISSUE_TEMPLATE/2-stream.yml | 117 ++++++++++++++++++ 3 files changed, 117 insertions(+), 2 deletions(-) rename .github/ISSUE_TEMPLATE/{1-docs-bug.yml => 0-docs.yml} (98%) rename .github/ISSUE_TEMPLATE/{0-core-bug.yml => 1-core.yml} (99%) create mode 100644 .github/ISSUE_TEMPLATE/2-stream.yml diff --git a/.github/ISSUE_TEMPLATE/1-docs-bug.yml b/.github/ISSUE_TEMPLATE/0-docs.yml similarity index 98% rename from .github/ISSUE_TEMPLATE/1-docs-bug.yml rename to .github/ISSUE_TEMPLATE/0-docs.yml index ecd5374b6..964a2b689 100644 --- a/.github/ISSUE_TEMPLATE/1-docs-bug.yml +++ b/.github/ISSUE_TEMPLATE/0-docs.yml @@ -2,7 +2,6 @@ name: '📃 Documentation Issue' description: Report an issue with Mithril.js's documentation assignees: dead-claudia labels: -- 'Type: Bug' - 'Area: Documentation' body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/0-core-bug.yml b/.github/ISSUE_TEMPLATE/1-core.yml similarity index 99% rename from .github/ISSUE_TEMPLATE/0-core-bug.yml rename to .github/ISSUE_TEMPLATE/1-core.yml index 43bd52eb3..bd1cc4fca 100644 --- a/.github/ISSUE_TEMPLATE/0-core-bug.yml +++ b/.github/ISSUE_TEMPLATE/1-core.yml @@ -2,7 +2,6 @@ name: '🐛 Framework Bug' description: Report a bug in Mithril.js core assignees: dead-claudia labels: -- 'Type: Bug' - 'Area: Core' body: - type: checkboxes diff --git a/.github/ISSUE_TEMPLATE/2-stream.yml b/.github/ISSUE_TEMPLATE/2-stream.yml new file mode 100644 index 000000000..2434524b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-stream.yml @@ -0,0 +1,117 @@ +name: '🌊 Mithril.js Streams bug' +description: Report an issue with Mithril.js's Streams module +assignees: dead-claudia +labels: +- 'Area: Stream' +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 (stores everything in URL hash) + - JSFiddle + - CodePen + - JSBin + - Plunker + - Glitch (supports backend) + - CodeSandbox (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.