forked from neon-bindings/neon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Created two issue templates and updated the contribution doc. Fixes: n…
- Loading branch information
1 parent
3c6f62d
commit aa17a48
Showing
3 changed files
with
146 additions
and
3 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,75 @@ | ||
| name: "Found a Bug! 🐛" | ||
| title: "🐛 [BUG] - <title>" | ||
| description: "Use this template to report a bug. Thank you!" | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks in advance for taking the time to file this issue! | ||
| We hope this simple template will improve issue resolution time and minimize the need for _context discovery_ discussions. | ||
| ______ | ||
| **Note**: We encourage you to [submit an RFC](https://github.com/neon-bindings/rfcs) if you would like to propose a **design change** or a **new feature** for the Neon API or the Neon command-line tool. | ||
| ______ | ||
| In addition to the `bug` label, consider adding others you might find relevant: | ||
| | Label | Description | | ||
| |:-----:|-------------| | ||
| | `CI` | Continuous Integration | | ||
| | `CLI` | Command Line Interface | | ||
| | `beginner friendly` | Great for those just starting out | | ||
| | `Performance` | Anything that affects performance | | ||
| | `linux` | Specific to Linux | | ||
| | `macos` | Specific to MacOS | | ||
| | `windows` | Specific to Windows | | ||
| | `android` | Specific to Android | | ||
| | `electron` | Specific to Electron apps | | ||
| - type: textarea | ||
| id: issue_summary | ||
| attributes: | ||
| label: Short Summary | ||
| description: Please provide a brief description of the issue | ||
| placeholder: "example: neon crashes when ..." | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: issue_repro | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: "Help us reproduce this issue with some step-by-step instructions" | ||
| value: | | ||
| 1. | ||
| 2. | ||
| 3. | ||
| ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: issue_fix | ||
| attributes: | ||
| label: Suggested fix | ||
| description: "If you have a proposed way to fix this bug, please summarize below. PRs work too :)" | ||
| - type: input | ||
| id: node_version | ||
| attributes: | ||
| label: "Node version: " | ||
| description: "Please specify the version of `node` you are running" | ||
| placeholder: "v18.10.0" | ||
| - type: input | ||
| id: npm_version | ||
| attributes: | ||
| label: "Node Package Manager version: " | ||
| description: "Please specify the version of `npm` you are running" | ||
| placeholder: "8.19.2" | ||
| - type: input | ||
| id: neon_version | ||
| attributes: | ||
| label: "NEON version(s): " | ||
| description: "Please specify the versions of `neon` that exhibit this issue" | ||
| placeholder: "example: v0.10.0, v0.9.x" | ||
| - type: input | ||
| id: os_version_arch | ||
| attributes: | ||
| label: OS Version | ||
| description: "Please provide your OS version and Architecture" | ||
| placeholder: "example: macOS 12.5.1 Intel" |
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,67 @@ | ||
| name: New Issue | ||
| title: Neon Issue | ||
| description: Use this template for all issues that are not bugs. | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks in advance for taking the time to file this issue! | ||
| If you think this is a 🐛 bug, please use the [bug issue template](https://github.com/neon-bindings/issues/new?assignees=&labels=&template=default_issue.yml&title=Neon+Issue). | ||
| Otherwise, please help us stay organized by selecting one or more of the following labels as applicable to your new issue. | ||
| | Label | Description | | ||
| |:-----:|-------------| | ||
| | `CI` | Continuous Integration | | ||
| | `CLI` | Command Line Interface | | ||
| | `beginner friendly` | Great for those just starting out | | ||
| | `enhancement` | For new features/design changes, use an [RFC](https://github.com/neon-bindings/rfcs) | | ||
| | `Performance` | Anything that affects performance | | ||
| | `linux` | Specific to Linux | | ||
| | `macos` | Specific to MacOS | | ||
| | `windows` | Specific to Windows | | ||
| | `android` | Specific to Android | | ||
| | `electron` | Specific to Electron apps | | ||
| --- | ||
| - | ||
| attributes: | ||
| description: "Please provide a brief description of the issue" | ||
| label: "Short Summary" | ||
| placeholder: "example: the issue template should be dynamically generated..." | ||
| id: issue_summary | ||
| type: textarea | ||
| validations: | ||
| required: true | ||
| - | ||
| attributes: | ||
| value: "> For context, please give us some details of your setup:\n" | ||
| type: markdown | ||
| - | ||
| attributes: | ||
| description: "Please specify the version of `node` you are running" | ||
| label: "Node version: " | ||
| placeholder: v18.10.0 | ||
| id: node_version | ||
| type: input | ||
| - | ||
| attributes: | ||
| description: "Please specify the version of `npm` you are running" | ||
| label: "Node Package Manager version: " | ||
| placeholder: "8.19.2" | ||
| id: npm_version | ||
| type: input | ||
| - | ||
| attributes: | ||
| description: "Please specify the versions of `neon` that exhibit this issue" | ||
| label: "NEON version(s): " | ||
| placeholder: "example: v0.10.0, v0.9.x" | ||
| id: neon_version | ||
| type: input | ||
| - | ||
| attributes: | ||
| description: "Please provide your OS version and Architecture" | ||
| label: "OS Version" | ||
| placeholder: "example: macOS 12.5.1 Intel" | ||
| id: os_version_arch | ||
| type: input |
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