-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added issue templates for bug report and feature request. (#193)
- Loading branch information
1 parent
82cd7f2
commit a35fc3a
Showing
2 changed files
with
140 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: Bug Report | ||
description: File a bug report | ||
title: "[bug]: " | ||
labels: ["bug", "triage"] | ||
assignees: | ||
- davidsouther | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to fill out a bug report on the NAND2Tetris Web IDE or VSCode Extension | ||
- type: dropdown | ||
id: program | ||
attributes: | ||
label: Program | ||
description: Which NAND2Tetris program were you using? | ||
options: | ||
- Hardware Simulator | ||
- CPU Emulator (coming soon) | ||
- Assembler (coming soon) | ||
- VM Emulator (coming soon) | ||
- type: dropdown | ||
id: interface | ||
attributes: | ||
label: Interface | ||
description: Which NAND2Tetris interface were you using? | ||
options: | ||
- Website (https://nand2tetris.github.io/web-ide) | ||
- VSCode Extension (coming soon, or manually installed) | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What would you like? | ||
description: In as much detail as possible, what would you like to have or see in the program? | ||
placeholder: Tell us what you want! | ||
value: "I want this!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-comments | ||
attributes: | ||
label: Additional Comments | ||
description: What else, if anything, would you like to share with us? | ||
placeholder: "Tell us anything!" | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: self-fix | ||
attributes: | ||
label: Do you want to try to fix this bug? | ||
description: The IDE is written in TypeScript, and includes React components. Do you want to try to fix the bug yourself (optional question)? If so, you can fork the repo, try to make the fix, and submit a PR. | ||
options: | ||
- label: I want to try to add this feature! | ||
required: false | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nand2tetris/web-ide/blob/main/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: Feature Request | ||
description: Request to add or improve a feature | ||
title: "[feature]: " | ||
labels: ["feature", "triage"] | ||
assignees: | ||
- davidsouther | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thank you for taking the time to fill out a feature request on the NAND2Tetris Web IDE or VSCode Extension | ||
- type: dropdown | ||
id: program | ||
attributes: | ||
label: Program | ||
description: Which NAND2Tetris program were you using? | ||
options: | ||
- Hardware Simulator | ||
- CPU Emulator (coming soon) | ||
- Assembler (coming soon) | ||
- VM Emulator (coming soon) | ||
- type: dropdown | ||
id: interface | ||
attributes: | ||
label: Interface | ||
description: Which NAND2Tetris interface were you using? | ||
options: | ||
- Website (https://nand2tetris.github.io/web-ide) | ||
- VSCode Extension (coming soon, or manually installed) | ||
- type: input | ||
id: contact | ||
attributes: | ||
label: Contact Details | ||
description: How can we get in touch with you if we need more info? | ||
placeholder: ex. [email protected] | ||
validations: | ||
required: false | ||
- type: textarea | ||
id: what-happened | ||
attributes: | ||
label: What happened? | ||
description: Also tell us, what did you expect to happen? | ||
placeholder: Tell us what you see! | ||
value: "A bug happened!" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-comments | ||
attributes: | ||
label: Additional Comments | ||
description: What else, if anything, would you like to share with us? | ||
placeholder: Tell us anything! | ||
validations: | ||
required: false | ||
- type: checkboxes | ||
id: self-fix | ||
attributes: | ||
label: Do you want to try to fix this bug? | ||
description: The IDE is written in Javascript, and includes React components. Do you want to try to fix the bug yourself (optional question)? If so, you can fork the repo, try to make the fix, and submit a PR. | ||
options: | ||
- label: I want to try to fix this bug | ||
required: false | ||
- type: checkboxes | ||
id: terms | ||
attributes: | ||
label: Code of Conduct | ||
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/nand2tetris/web-ide/blob/main/CODE_OF_CONDUCT.md) | ||
options: | ||
- label: I agree to follow this project's Code of Conduct | ||
required: true |