Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update org/repo urls #1879

Merged
merged 1 commit into from May 26, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .generators/package.json
Expand Up @@ -14,6 +14,6 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "git://github.com/node-serialport/node-serialport.git"
"url": "git://github.com/serialport/node-serialport.git"
}
}
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
@@ -1 +1 @@
## 👉 [Please follow one of these issue templates](https://github.com/node-serialport/node-serialport/issues/new/choose) 👈
## 👉 [Please follow one of these issue templates](https://github.com/serialport/node-serialport/issues/new/choose) 👈
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/docs.md
Expand Up @@ -7,6 +7,6 @@ about: Report an issue related to 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)?
### Have you read the [Contributing Guidelines on docs](https://github.com/serialport/node-serialport/blob/master/CONTRIBUTING.md#writing-documentation)?

(Write your answer here.)
20 changes: 5 additions & 15 deletions CONTRIBUTING.md
Expand Up @@ -15,13 +15,13 @@ 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 follow the issue template.
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.

<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/1264) and create a [github issue](https://github.com/node-serialport/node-serialport/issues) and include:
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

Expand All @@ -44,24 +44,14 @@ It's very important that your pull requests include all of the above in order fo
<a name="writing-tests"></a>
## 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/node-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.

<a name="writing-docs"></a>
## 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/node-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.

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.
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)

<a name="sample-projects"></a>
## Sample Projects
Expand Down
40 changes: 33 additions & 7 deletions README.md
@@ -1,17 +1,17 @@
# Node Serialport
[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![codecov](https://codecov.io/gh/node-serialport/node-serialport/branch/master/graph/badge.svg)](https://codecov.io/gh/node-serialport/node-serialport)
[![Build Status](https://travis-ci.org/node-serialport/node-serialport.svg?branch=master)](https://travis-ci.org/node-serialport/node-serialport)
[![Backers on Open Collective](https://opencollective.com/serialport-monorepo/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/serialport-monorepo/sponsors/badge.svg)](#sponsors) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)
[![codecov](https://codecov.io/gh/serialport/node-serialport/branch/master/graph/badge.svg)](https://codecov.io/gh/serialport/node-serialport)
[![Build Status](https://travis-ci.org/serialport/node-serialport.svg?branch=master)](https://travis-ci.org/serialport/node-serialport)
[![Build status](https://ci.appveyor.com/api/projects/status/ijg4rnd9vi16tbgr/branch/master?svg=true)](https://ci.appveyor.com/project/serialport/node-serialport/branch/master)
[![Greenkeeper badge](https://badges.greenkeeper.io/node-serialport/node-serialport.svg)](https://greenkeeper.io/)
[![Greenkeeper badge](https://badges.greenkeeper.io/serialport/node-serialport.svg)](https://greenkeeper.io/)

Working with serial ports can be hard, this is a collection of projects that make it easier.
Access serial ports with JavaScript. Linux, OSX and Windows. Welcome your robotic JavaScript overlords. Better yet, program them!

> Go to https://serialport.io/ to learn more, find guides and api documentation.

## Quick Links
- [**Guides**](https://serialport.io/docs/guide-about)
- [**API Docs**](https://serialport.io/docs/en/api-serialport)
- [**API Docs**](https://serialport.io/docs/api-serialport)
- [The `serialport` package api docs](https://serialport.io/docs/api-serialport)


Expand Down Expand Up @@ -46,7 +46,7 @@ Parsers are traditionally Transform streams, but Duplex streams and other non st
## Developing

### Developing node serialport projects
1. Clone this repo `git clone git@github.com:node-serialport/node-serialport.git`
1. Clone this repo `git clone git@github.com:serialport/node-serialport.git`
1. Run `npm install` to setup local package dependencies (run this any time you depend on a package local to this repo)
1. Run `npm test` to ensure everything is working properly
1. Run `npm run generate` to generate a new project
Expand All @@ -56,6 +56,32 @@ Parsers are traditionally Transform streams, but Duplex streams and other non st

See https://github.com/node-serialport/website

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
<a href="https://github.com/undefined/undefinedgraphs/contributors"><img src="https://opencollective.com/serialport-monorepo/contributors.svg?width=890&button=false" /></a>

## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/serialport-monorepo#backer)]

<a href="https://opencollective.com/serialport-monorepo#backers" target="_blank"><img src="https://opencollective.com/serialport-monorepo/backers.svg?width=890"></a>

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/serialport-monorepo#sponsor)]

<a href="https://opencollective.com/serialport-monorepo/sponsor/0/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/1/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/2/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/3/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/4/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/5/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/6/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/7/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/8/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/serialport-monorepo/sponsor/9/website" target="_blank"><img src="https://opencollective.com/serialport-monorepo/sponsor/9/avatar.svg"></a>

## License
SerialPort packages are all [MIT licensed](LICENSE) and all it's dependencies are MIT licensed.

Expand Down
14 changes: 7 additions & 7 deletions packages/binding-abstract/CHANGELOG.md
Expand Up @@ -3,12 +3,12 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# [3.0.0](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.5...@serialport/binding-abstract@3.0.0) (2019-05-16)
# [3.0.0](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.5...@serialport/binding-abstract@3.0.0) (2019-05-16)


### chore

* remove node6 support and upgrade codebase ([#1851](https://github.com/node-serialport/node-serialport/issues/1851)) ([d4f15c0](https://github.com/node-serialport/node-serialport/commit/d4f15c0))
* remove node6 support and upgrade codebase ([#1851](https://github.com/serialport/node-serialport/issues/1851)) ([d4f15c0](https://github.com/serialport/node-serialport/commit/d4f15c0))


### BREAKING CHANGES
Expand All @@ -19,31 +19,31 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline



## [2.0.5](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.4...@serialport/binding-abstract@2.0.5) (2019-04-27)
## [2.0.5](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.4...@serialport/binding-abstract@2.0.5) (2019-04-27)

**Note:** Version bump only for package @serialport/binding-abstract





## [2.0.4](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.3...@serialport/binding-abstract@2.0.4) (2019-01-08)
## [2.0.4](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.3...@serialport/binding-abstract@2.0.4) (2019-01-08)

**Note:** Version bump only for package @serialport/binding-abstract





## [2.0.3](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.2...@serialport/binding-abstract@2.0.3) (2018-12-19)
## [2.0.3](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.2...@serialport/binding-abstract@2.0.3) (2018-12-19)

**Note:** Version bump only for package @serialport/binding-abstract





## [2.0.2](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.1...@serialport/binding-abstract@2.0.2) (2018-11-27)
## [2.0.2](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.1...@serialport/binding-abstract@2.0.2) (2018-11-27)

**Note:** Version bump only for package @serialport/binding-abstract

Expand All @@ -52,7 +52,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline


<a name="2.0.1"></a>
## [2.0.1](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-abstract@2.0.0...@serialport/binding-abstract@2.0.1) (2018-08-29)
## [2.0.1](https://github.com/serialport/node-serialport/compare/@serialport/binding-abstract@2.0.0...@serialport/binding-abstract@2.0.1) (2018-08-29)

**Note:** Version bump only for package @serialport/binding-abstract

Expand Down
2 changes: 1 addition & 1 deletion packages/binding-abstract/package.json
Expand Up @@ -17,6 +17,6 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "git://github.com/node-serialport/node-serialport.git"
"url": "git://github.com/serialport/node-serialport.git"
}
}
14 changes: 7 additions & 7 deletions packages/binding-mock/CHANGELOG.md
Expand Up @@ -3,12 +3,12 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

# [3.0.0](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.5...@serialport/binding-mock@3.0.0) (2019-05-16)
# [3.0.0](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.5...@serialport/binding-mock@3.0.0) (2019-05-16)


### chore

* remove node6 support and upgrade codebase ([#1851](https://github.com/node-serialport/node-serialport/issues/1851)) ([d4f15c0](https://github.com/node-serialport/node-serialport/commit/d4f15c0))
* remove node6 support and upgrade codebase ([#1851](https://github.com/serialport/node-serialport/issues/1851)) ([d4f15c0](https://github.com/serialport/node-serialport/commit/d4f15c0))


### BREAKING CHANGES
Expand All @@ -19,31 +19,31 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline



## [2.0.5](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.4...@serialport/binding-mock@2.0.5) (2019-04-27)
## [2.0.5](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.4...@serialport/binding-mock@2.0.5) (2019-04-27)

**Note:** Version bump only for package @serialport/binding-mock





## [2.0.4](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.3...@serialport/binding-mock@2.0.4) (2019-01-08)
## [2.0.4](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.3...@serialport/binding-mock@2.0.4) (2019-01-08)

**Note:** Version bump only for package @serialport/binding-mock





## [2.0.3](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.2...@serialport/binding-mock@2.0.3) (2018-12-19)
## [2.0.3](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.2...@serialport/binding-mock@2.0.3) (2018-12-19)

**Note:** Version bump only for package @serialport/binding-mock





## [2.0.2](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.1...@serialport/binding-mock@2.0.2) (2018-11-27)
## [2.0.2](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.1...@serialport/binding-mock@2.0.2) (2018-11-27)

**Note:** Version bump only for package @serialport/binding-mock

Expand All @@ -52,7 +52,7 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline


<a name="2.0.1"></a>
## [2.0.1](https://github.com/node-serialport/node-serialport/compare/@serialport/binding-mock@2.0.0...@serialport/binding-mock@2.0.1) (2018-08-29)
## [2.0.1](https://github.com/serialport/node-serialport/compare/@serialport/binding-mock@2.0.0...@serialport/binding-mock@2.0.1) (2018-08-29)

**Note:** Version bump only for package @serialport/binding-mock

Expand Down
2 changes: 1 addition & 1 deletion packages/binding-mock/package.json
Expand Up @@ -18,6 +18,6 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "git://github.com/node-serialport/node-serialport.git"
"url": "git://github.com/serialport/node-serialport.git"
}
}