Skip to content

Commit

Permalink
docs: new issue templates (#1663)
Browse files Browse the repository at this point in the history
Borrow from some of Docusaurus's excellent issue templates and some of our own.
  • Loading branch information
reconbot authored Sep 15, 2018
1 parent 6c7fe61 commit 9c3c4fb
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 12 deletions.
10 changes: 1 addition & 9 deletions .github/ISSUE_TEMPLATE.md
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) 👈
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/docs.md
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.)
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/proposal.md
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!
-->
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/support.md
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)
17 changes: 14 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ If the issue has been reported before but you have new information to help troub
## Requesting Features
To request a new feature be added take a look at the [current roadmap](https://github.com/node-serialport/node-serialport/issues/746) and create a [github issue](https://github.com/node-serialport/node-serialport/issues) and include:

**What feature you'd like to see:**
**Why this is important to you:** (this is here because it's interesting knowing what cool things people are working on and also could help community members make suggestions for work-arounds until the feature is built)
### What feature you'd like to see

### Why this is important to you

This is here because it's interesting knowing what cool things people are working on and also could help community members make suggestions for work-arounds until the feature is built.

<a name="pullrequests"></a>
## Submitting Pull Requests
Expand All @@ -48,7 +51,15 @@ Tests are written using [mocha](https://mochajs.org/), [chai](http://chaijs.com/

We are always looking to improve our docs. If you find that any are lacking information or have wrong information, fix and submit a PR. If you're looking for areas to start writing docs for, see the [docs](https://github.com/node-serialport/node-serialport/labels/docs) label in issues.

We use [jsdoc](http://usejsdoc.org/) to generate our docs. Make your changes to `.docs/README.hbs` or the documentation blocks in the JavaScript files and run `npm run docs` to update `README.md`.
We use [Docusaurus](https://docusaurus.io/) to generate our docs. Make your changes to `/docs/` or in the `/packages/website/` folder.

You can preview the docs by running

```bash
npm run docs:dev
```

Or clicking the netlify link in your PR.

Docs should have tested and working sample code. Many people using SerialPort are learning how to work with hardware for the first time, so write for a beginner audience.

Expand Down

0 comments on commit 9c3c4fb

Please sign in to comment.