-
-
Notifications
You must be signed in to change notification settings - Fork 1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Borrow from some of Docusaurus's excellent issue templates and some of our own.
- Loading branch information
Showing
5 changed files
with
82 additions
and
12 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 |
---|---|---|
@@ -1,9 +1 @@ | ||
### Summary of Problem | ||
|
||
### Steps and Code to Reproduce the Issue | ||
|
||
### Package name(s) and version(s) | ||
|
||
### Node version, Operating System and hardware | ||
|
||
<!-- Make sure you check out the Electron docs and the __Installation Special Cases__ section! --> | ||
## 👉 [Please follow one of these issue templates](https://github.com/node-serialport/node-serialport/issues/new/choose) 👈 |
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,12 @@ | ||
--- | ||
name: 📚 Documentation | ||
about: Report an issue related to documentation | ||
--- | ||
|
||
## 📚 Documentation | ||
|
||
(A clear and concise description of how the docs could be better, with links if possible) | ||
|
||
### Have you read the [Contributing Guidelines on docs](https://github.com/node-serialport/node-serialport/blob/master/CONTRIBUTING.md#writing-documentation)? | ||
|
||
(Write your answer here.) |
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,26 @@ | ||
--- | ||
name: 💥 Proposal / Feature | ||
about: Propose a non-trivial change or new feature for SerialPort | ||
--- | ||
|
||
## 💥 Proposal | ||
|
||
### What feature you'd like to see | ||
(A clear and concise description of what the proposal is.) | ||
|
||
## Motivation | ||
(Please outline the motivation for the proposal. It's interesting knowing what people are working on and also could help community members make suggestions for work-arounds until the feature is built) | ||
|
||
## Pitch | ||
|
||
(Please explain why this feature should be implemented and how it would be used.) | ||
|
||
<!-- | ||
What happens if you skip this step? | ||
Someone will read your feature proposal and maybe will be able to help you, | ||
but it’s unlikely that it will get much attention from the team. Eventually, | ||
the issue will likely get closed in favor of issues that have better explanations | ||
Thanks for helping us help you! | ||
--> |
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,29 @@ | ||
--- | ||
name: ❓ Questions/Help | ||
about: As a support question | ||
--- | ||
|
||
<!-- Having trouble installing? Be sure to check out the installation docs! https://serialport.io/docs/guide-installation --> | ||
|
||
### Summary of Problem | ||
|
||
(Please answer all 3) | ||
|
||
- What are you trying to do? | ||
- What happens? | ||
- What should have happened? | ||
|
||
### Code to Reproduce the Issue | ||
|
||
```js | ||
const serialport = new SerialPort(path) | ||
|
||
// Code | ||
``` | ||
|
||
### Versions, Operating System and Hardware | ||
|
||
- SerialPort@? | ||
- Node.js v? | ||
- Windows? Linux? Mac? | ||
- Hardware and chipset? (Prolific/FTDI/Other) |
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