Skip to content

Commit

Permalink
docs(contributing): clean up the instructions a little bit
Browse files Browse the repository at this point in the history
  • Loading branch information
reconbot committed Mar 11, 2018
1 parent 37a8373 commit 71f2480
Showing 1 changed file with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,10 @@ There are a lot of ways to get involved and help out:
<a name="reporting-issues"></a>
## Reporting An Issue

SerialPort does it's [issue tracking](https://github.com/node-serialport/node-serialport/issues) through github. To report an issue first search the repo to make sure that it has not been reported before. If no one has reported the bug before, create a new issue and be sure to include the following information:

Operating System and Hardware:
NodeJS Version:
Serialport version:
Python Version (if you're having trouble building serialport):


**Operating System:** (e.g Windows, OSX, Linux)
**NodeJS Version:**
**SerialPort Version**
**Hardware you are having an issue with:** (e.g. arduino, another computer, etc)
**What your expectations are:**
**What the actual outcome is:**
**Steps to reproduce (including code samples):**
SerialPort does it's [issue tracking](https://github.com/node-serialport/node-serialport/issues) through github. To report an issue first search the repo to make sure that it has not been reported before. If no one has reported the bug before, create a new issue and be sure to follow the issue template.

If the issue has been reported before but you have new information to help troubleshoot the issue, add a comment to the thread with the same information as requested above.


<a name="requesting-features"></a>
## 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:
Expand All @@ -43,7 +28,7 @@ To request a new feature be added take a look at the [current roadmap](https://g

<a name="pullrequests"></a>
## Submitting Pull Requests
To contribute code to SerialPort, fork the project onto your github account and do your work in a branch. Before you submit the PR, make sure to rebase master into your branch so that you have the most recent changes and nothing breaks or conflicts. Lint and test your code using `npm lint` and `npm test`. Also squash your commits to a reasonable size before submitting.
To contribute code to SerialPort, fork the project onto your github account and do your work in a branch. Before you submit the PR, make sure to rebase master into your branch so that you have the most recent changes and nothing breaks or conflicts. Lint and test your code using `npm run lint` and `npm run test`.

All contributions must adhere to the eslint rules by maintaining the existing coding style.

Expand Down

0 comments on commit 71f2480

Please sign in to comment.