mirror of
https://github.com/enso-org/enso.git
synced 2024-11-22 22:10:15 +03:00
New issue templates (#5580)
This commit is contained in:
parent
c39410b4d1
commit
84bc8cd514
67
.github/ISSUE_TEMPLATE/bug-report.md
vendored
67
.github/ISSUE_TEMPLATE/bug-report.md
vendored
@ -1,67 +0,0 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug in Enso
|
||||
title: ""
|
||||
labels: "Type: Bug"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!--
|
||||
Please ensure that you are running the latest version of Enso before reporting
|
||||
the bug! It may have been fixed since.
|
||||
-->
|
||||
|
||||
### General Summary
|
||||
|
||||
<!--
|
||||
- Please include a high-level description of your bug here.
|
||||
-->
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
<!--
|
||||
Please list the reproduction steps for your bug. For example:
|
||||
|
||||
1. Launch the enso interpreter in server mode `enso --server --socket=8080`.
|
||||
2. Send it a message as follows, where `path/to/project` doesn't exist.
|
||||
|
||||
```json
|
||||
{
|
||||
message-type: "load-project",
|
||||
load-project: {
|
||||
path: "path/to/project"
|
||||
}
|
||||
...
|
||||
}
|
||||
```
|
||||
3. Observe that the compiler crashes.
|
||||
-->
|
||||
|
||||
### Expected Result
|
||||
|
||||
<!--
|
||||
- A description of the results you expected from the reproduction steps.
|
||||
-->
|
||||
|
||||
### Actual Result
|
||||
|
||||
<!--
|
||||
- A description of what actually happens when you run these steps.
|
||||
- Please include any error output if relevant.
|
||||
-->
|
||||
|
||||
### Enso Version
|
||||
|
||||
<!--
|
||||
- Please include the output of `enso --version`.
|
||||
|
||||
For example:
|
||||
```
|
||||
Enso Compiler and Runtime
|
||||
Version: 0.1.0
|
||||
Built with: scala-2.13.3 for GraalVM 20.2.0
|
||||
Built from: main* @ 919ffbdfacc44cc35a1b38f1bad5b573acdbe358
|
||||
Running on: OpenJDK 64-Bit Server VM, GraalVM Community, JDK 11.0.8+10-jvmci-20.2-b03
|
||||
Linux 4.15.0-112-generic (amd64)
|
||||
```
|
||||
-->
|
142
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
142
.github/ISSUE_TEMPLATE/bug-report.yml
vendored
Normal file
@ -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 <kbd>cmd</kbd> + <kbd>?</kbd> (MacOS) or <kbd>ctrl</kbd> + <kbd>?</kbd> (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
|
24
.github/ISSUE_TEMPLATE/config.yml
vendored
24
.github/ISSUE_TEMPLATE/config.yml
vendored
@ -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.
|
||||
|
34
.github/ISSUE_TEMPLATE/epic.md
vendored
34
.github/ISSUE_TEMPLATE/epic.md
vendored
@ -1,34 +0,0 @@
|
||||
---
|
||||
name: Epic
|
||||
about: Create a new epic for Enso development
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
### Summary
|
||||
|
||||
<!--
|
||||
- This section should summarise the work we want to accomplish during the epic.
|
||||
-->
|
||||
|
||||
### Value
|
||||
|
||||
<!--
|
||||
- A description of the value this epic brings to users.
|
||||
- The motivation behind this epic.
|
||||
-->
|
||||
|
||||
### Specification
|
||||
|
||||
<!--
|
||||
- The high-level requirements of the epic.
|
||||
- Any performance requirements for the epic.
|
||||
-->
|
||||
|
||||
### Acceptance Criteria & Test Cases
|
||||
|
||||
<!--
|
||||
- The high-level acceptance criteria for the epic.
|
||||
- The test plan for the epic.
|
||||
-->
|
25
.github/ISSUE_TEMPLATE/feature-request.md
vendored
25
.github/ISSUE_TEMPLATE/feature-request.md
vendored
@ -1,25 +0,0 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Request a new feature in Enso
|
||||
title: ""
|
||||
labels: "Type: Enhancement"
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
<!--
|
||||
Please ensure that you check the latest version of Enso to see if your feature
|
||||
has been implemented.
|
||||
-->
|
||||
|
||||
### General Summary
|
||||
|
||||
<!--
|
||||
- Describe the feature you are requesting.
|
||||
-->
|
||||
|
||||
### Motivation
|
||||
|
||||
<!--
|
||||
- A description of the motivation for adding this feature to Enso.
|
||||
- Ideally this would include use-cases that support the feature.
|
||||
-->
|
64
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
64
.github/ISSUE_TEMPLATE/feature-request.yml
vendored
Normal file
@ -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
|
34
.github/ISSUE_TEMPLATE/task.md
vendored
34
.github/ISSUE_TEMPLATE/task.md
vendored
@ -1,34 +0,0 @@
|
||||
---
|
||||
name: Task
|
||||
about: Create a new development task for Enso
|
||||
title: ""
|
||||
labels: ""
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
### Summary
|
||||
|
||||
<!--
|
||||
- A summary of the task.
|
||||
-->
|
||||
|
||||
### Value
|
||||
|
||||
<!--
|
||||
- This section should describe the value of this task.
|
||||
- This value can be for users, to the team, etc.
|
||||
-->
|
||||
|
||||
### Specification
|
||||
|
||||
<!--
|
||||
- Detailed requirements for the feature.
|
||||
- The performance requirements for the feature.
|
||||
-->
|
||||
|
||||
### Acceptance Criteria & Test Cases
|
||||
|
||||
<!--
|
||||
- Any criteria that must be satisfied for the task to be accepted.
|
||||
- The test plan for the feature, related to the acceptance criteria.
|
||||
-->
|
Loading…
Reference in New Issue
Block a user