From 84bc8cd514f68275379cf24fcd7865b2c6baa2a6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wojciech=20Dani=C5=82o?= Date: Tue, 7 Feb 2023 15:58:12 +0100 Subject: [PATCH] New issue templates (#5580) --- .github/ISSUE_TEMPLATE/bug-report.md | 67 ---------- .github/ISSUE_TEMPLATE/bug-report.yml | 142 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 24 ++-- .github/ISSUE_TEMPLATE/epic.md | 34 ----- .github/ISSUE_TEMPLATE/feature-request.md | 25 ---- .github/ISSUE_TEMPLATE/feature-request.yml | 64 ++++++++++ .github/ISSUE_TEMPLATE/task.md | 34 ----- 7 files changed, 218 insertions(+), 172 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yml delete mode 100644 .github/ISSUE_TEMPLATE/epic.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yml delete mode 100644 .github/ISSUE_TEMPLATE/task.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 4bb2087b36..0000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -name: Bug Report -about: Report a bug in Enso -title: "" -labels: "Type: Bug" -assignees: "" ---- - - - -### General Summary - - - -### Steps to Reproduce - - - -### Expected Result - - - -### Actual Result - - - -### Enso Version - - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000000..ccba8f34db --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,142 @@ +name: "Bug Report" +description: "Found a bug? We'd appreciate if you'd first search through our open issues and docs, to make sure the issue isn't already known." +labels: ["--bug", "triage"] +assignees: ["sylwiabr", "xvcgreg"] +body: + - type: "input" + id: "discord-id" + attributes: + label: "Discord username (optional)" + description: "If you're in our [Discord server](https://discord.gg/enso), please include your [Discord ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) formatted like so: `username#1234` (you can find it by clicking your profile on the bottom left of the application). This is so we can ask questions interactively and give you the `Bug Catcher` Discord role." + placeholder: "username#1234" + validations: + required: false + + - type: "dropdown" + id: "issue-type" + attributes: + label: "What type of issue is this? (required)" + multiple: false + options: + - "Transient – Occuring only once" + - "Intermittent – Ocurring irregularly" + - "Permanent – Ocurring repeatably" + validations: + required: true + + - type: "checkboxes" + id: "blocker" + attributes: + label: "Is this issue blocking you from using Enso? (optional)" + description: "We will review and try to fix all issues, even if you don't select this option." + options: + - label: "Yes, I can't use Enso because of this issue." + + - type: "checkboxes" + id: "regression" + attributes: + label: "Is this a regression? (optional)" + description: "Leave it unchecked if unsure, please." + options: + - label: "Yes, previous version of Enso did not have this issue." + + - type: textarea + id: "description" + attributes: + label: "What issue are you facing? (required)" + description: "A clear and concise description of what issue are you facing." + validations: + required: true + + - type: textarea + id: "expected-behaviour" + attributes: + label: "Expected behaviour (required)" + description: "A clear and concise description of what you expected to happen." + validations: + required: true + + - type: textarea + id: "how-to-reproduce" + attributes: + label: "How we can reproduce it? (optional)" + description: "Bug reports with clear reproduction will get prioritized higher and addressed more quickly." + placeholder: | + Steps to reproduce: + 1. Click on ... + 2. Scroll down to ... + 3. See error ... + validations: + required: false + + - type: textarea + id: "screenshots" + attributes: + label: "Screenshots or screencasts (optional)" + description: "If applicable, add screenshots or screencasts to help explain your problem. While optional, they help expedite the time in which your bug is addressed." + validations: + required: false + + - type: input + id: "enso-version" + attributes: + label: "Enso Version (required)" + description: "Press cmd + ? (MacOS) or ctrl + ? (other operating systems) and paste here the output you see. Alternatively, provide us with the version of the package that you downloaded." + validations: + required: true + + - type: dropdown + id: "browser" + attributes: + label: "Browser or standalone distribution (required)" + description: "On which browser do you experience this issue?" + multiple: true + options: + - "Standalone distribution" + - "Chrome" + - "Chromium" + - "Safari (not supported officialy, but should work)" + - "Edge (not supported officialy, but should work)" + - "Firefox (not supported officialy, but should work)" + - "Opera (not supported officialy, but should work)" + - Other (provide the browser name in the next field, please) + validations: + required: true + + - type: input + id: "browser-version" + attributes: + label: "Browser Version or standalone distribution (required)" + description: "If you are using standalone distribution, type `standalone` here." + validations: + required: true + + - type: dropdown + id: "os" + attributes: + label: "Operating System (required)" + multiple: false + options: + - MacOS + - Windows + - Linux + - Other (provide the OS name in the next field, please) + validations: + required: true + + - type: input + id: "os-version" + attributes: + label: "Operating System Version (required)" + description: "For example, `MacOS Ventura 13.2`." + validations: + required: false + + - type: input + id: "hardware" + attributes: + label: "Hardware you are using (optional)" + description: "Many issues, especially those connected to rendering, depend on the hardware you are using. Providing this info can be invaluable for us to discover why you are facing it." + placeholder: "Intel Xeon W, AMD Radeon Pro W5500X, 64GB RAM" + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a787e5661c..56559b7775 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,14 +1,14 @@ blank_issues_enabled: false contact_links: - - name: Issues with the IDE? - url: https://github.com/enso-org/ide/issues/new/choose - about: Please report problems with the IDE in the IDE repository - - name: Have a question about Enso? - url: https://github.com/enso-org/enso/discussions/new?category=Questions - about: Ask your questions about Enso - - name: Want to discuss Enso? - url: https://github.com/enso-org/enso/discussions/new?category=general - about: Talk about Enso the language - - name: Have an idea? - url: https://github.com/enso-org/enso/discussions/new?category=ideas - about: Share your ideas for Enso + - name: Enso Issue Search + url: https://github.com/enso-org/enso/issues?q=is%3Aissue+is%3Aopen+a+sort%3Acreated-asc + about: Search Enso's open issues and feature requests. + - name: Discord + url: https://discord.gg/enso + about: Discuss new data processing, report bugs, and brainstorm new features of Enso. + - name: Enso Website + url: https://enso.org/ + about: Our website. + - name: Changelog + url: https://github.com/enso-org/enso/blob/develop/CHANGELOG.md + about: See our changelog. diff --git a/.github/ISSUE_TEMPLATE/epic.md b/.github/ISSUE_TEMPLATE/epic.md deleted file mode 100644 index 0caac09dc7..0000000000 --- a/.github/ISSUE_TEMPLATE/epic.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Epic -about: Create a new epic for Enso development -title: "" -labels: "" -assignees: "" ---- - -### Summary - - - -### Value - - - -### Specification - - - -### Acceptance Criteria & Test Cases - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 1ec24a455a..0000000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -name: Feature Request -about: Request a new feature in Enso -title: "" -labels: "Type: Enhancement" -assignees: "" ---- - - - -### General Summary - - - -### Motivation - - diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000000..565bf58d0f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,64 @@ +name: "Feature Request" +description: "Have a great new idea? We'd love to know, please search through our existing feature requests, and upvote it if its already been submitted." +labels: ["-x-new-feature", "triage"] +assignees: ["sylwiabr", "xvcgreg"] +body: + - type: "input" + id: "discord-id" + attributes: + label: "Discord username (optional)" + description: "If you're in our [Discord server](https://discord.gg/enso), please include your [Discord ID](https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID-) formatted like so: `username#1234` (you can find it by clicking your profile on the bottom left of the application). This is so we can ask questions interactively and give you the `Ideas Contributor` Discord role." + placeholder: "username#1234" + validations: + required: false + + - type: "dropdown" + id: "issue-type" + attributes: + label: "How important is this feature to you? (required)" + multiple: false + options: + - "0 – Not too important" + - "1 – Not too important now, but possibly important in the future" + - "2 – Somewhat important, but I can live without it" + - "3 – Lack of it makes using Enso slightly harder" + - "4 – Lack of it makes using Enso a lot harder" + - "5 – Lack of it blocks me from doing my work in Enso" + validations: + required: true + + - type: textarea + id: "description" + attributes: + label: "Describe the idea you'd like to see implemented (required)" + description: "A clear and concise description of what you'd like to see in Enso." + validations: + required: true + + - type: textarea + id: "related-to-problem" + attributes: + label: "Is your feature request related to a problem? (optional)" + description: "A clear and concise description of what problem this feature request is related to." + validations: + required: true + + - type: textarea + id: "screenshots" + attributes: + label: "Screenshots, screencasts, mockups (optional)" + description: "If applicable, add screenshots, screencasts, or mockups that help explain your idea. While optional, images help explain ideas way better than words." + validations: + required: false + + - type: "dropdown" + id: "willing-to-help" + attributes: + label: "Would you be willing to help us implement this feature? (required)" + description: "If you are, we will help you get started, guide trough the codebase, and help with the proper design." + multiple: false + options: + - "No" + - "Yes" + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/task.md b/.github/ISSUE_TEMPLATE/task.md deleted file mode 100644 index 6076031006..0000000000 --- a/.github/ISSUE_TEMPLATE/task.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Task -about: Create a new development task for Enso -title: "" -labels: "" -assignees: "" ---- - -### Summary - - - -### Value - - - -### Specification - - - -### Acceptance Criteria & Test Cases - -