From f08434626ffa6e9a8a6ae1ffbf137a5614ee5815 Mon Sep 17 00:00:00 2001 From: Francis Gulotta Date: Thu, 1 Jan 2026 22:21:42 -0500 Subject: [PATCH] docs: update and cleanup some info --- CONTRIBUTING.md | 35 ++++++++++++++++++----------------- README.md | 6 +++--- SECURITY.md | 7 +------ 3 files changed, 22 insertions(+), 26 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 353b2674..3daed6fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,22 +5,26 @@ Do you want to help out but don't know where to start? ## Guideline Contents There are a lot of ways to get involved and help out: -- [Reporting an issue](#reporting-issues) -- [Requesting features](#requesting-features) -- [Submitting Pullrequests](#pullrequests) -- [Writing tests](#writing-tests) -- [Writing Documentation](#writing-docs) -- [Sample Projects](#sample-projects) - -## Reporting An Issue +- [Contribute to SerialPort!](#contribute-to-serialport) + - [Guideline Contents](#guideline-contents) + - [Reporting an Issue](#reporting-an-issue) + - [Requesting Features](#requesting-features) + - [What feature you'd like to see](#what-feature-youd-like-to-see) + - [Why this is important to you](#why-this-is-important-to-you) + - [Submitting Pull Requests](#submitting-pull-requests) + - [Writing Tests](#writing-tests) + - [Writing Documentation](#writing-documentation) + - [Sample Projects](#sample-projects) -SerialPort does it's [issue tracking](https://github.com/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. +## Reporting an Issue + +SerialPort does it's [issue tracking](https://github.com/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. - ## Requesting Features + To request a new feature be added take a look at the [current roadmap](https://github.com/serialport/node-serialport/milestones) and create a [github issue](https://github.com/serialport/node-serialport/issues) and include: ### What feature you'd like to see @@ -29,9 +33,9 @@ To request a new feature be added take a look at the [current roadmap](https://g 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. - ## 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 run lint` and `npm run test`. + +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. @@ -41,19 +45,16 @@ When contributing new features you must include documentation. It's very important that your pull requests include all of the above in order for users to be able to use your code. Pull requests with undocumented code will not be accepted. - ## Writing Tests -Tests are written using [mocha](https://mochajs.org/), [chai](http://chaijs.com/) and [sinon](http://sinonjs.org/). If you are having issues making a test pass, ask for help in the SerialPort [gitter](https://gitter.im/serialport/node-serialport) room or on your PR. Tests can be the hardest part to write when contributing code, so don't be discouraged. +Tests are written using [mocha](https://mochajs.org/), [chai](http://chaijs.com/) and [sinon](http://sinonjs.org/). If you are having issues making a test pass, ask for help in the SerialPort [gitter](https://gitter.im/serialport/node-serialport) room or on your PR. Tests can be the hardest part to write when contributing code, so don't be discouraged. - ## Writing Documentation -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/serialport/node-serialport/labels/docs) label in issues. +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/serialport/node-serialport/labels/docs) label in issues. We use [Docusaurus](https://docusaurus.io/) to generate our docs. Make your changes to `/docs/` or in the `/packages/website/` folder in the [website repo](https://github.com/serialport/website) - ## Sample Projects Have you made something cool with SerialPort? Is it part of your latest product? Let us know! There are a lot of people out there hacking on similar projects and looking for ideas, help or code. It's great to share! diff --git a/README.md b/README.md index 1bf126aa..74c44852 100644 --- a/README.md +++ b/README.md @@ -63,10 +63,10 @@ SerialPort is currently employees a [governance](https://medium.com/the-node-js- If you have a PR that improves the project people in any or all of the above people will help you land it. -**Maintainers** +### Maintainers -- [Francis Gulotta](https://twitter.com/reconbot) | [reconbot](https://github.com/reconbot) -- [Nick Hehr](https://twitter.com/hipsterbrown) | [hipsterbrown](https://github.com/hipsterbrown) +- [Francis Gulotta](https://toot.cafe/@reconbot) | [reconbot](https://github.com/reconbot) +- [Nick Hehr](https://toot.cafe/@hipsterbrown) | [hipsterbrown](https://github.com/hipsterbrown) ### Contributors diff --git a/SECURITY.md b/SECURITY.md index 1a4d217c..c94df04f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -4,11 +4,6 @@ We currently support the latest version of serialport only. -| Version | Supported | -| ------- | ------------------ | -| 9.x.x | :white_check_mark: | -| < 9.0.x | :x: | - ## Reporting a Vulnerability -Please email security@serialport.io if you find any issues and we'll talk about it. You can find a GPG key on keybase. +Please email security@serialport.io if you find any issues and we'll talk about it.