This repository has been archived by the owner on Mar 10, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c1d8ea2
commit 1b5e495
Showing
3 changed files
with
71 additions
and
1 deletion.
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 +1,6 @@ | ||
|
||
|
||
<a name="0.0.1"></a> | ||
# 0.0.1 | ||
|
||
Initial release. No features but also no bugs. |
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,58 @@ | ||
# Contributing | ||
|
||
## Setup | ||
|
||
You should have [node.js] and [npm] installed. | ||
|
||
## Linting | ||
|
||
Linting is done using [eslint] and the rules are based on [standard]. | ||
|
||
```bash | ||
$ npm run lint | ||
``` | ||
|
||
## Tests | ||
|
||
Tests in node | ||
|
||
```bash | ||
$ npm run test:node | ||
``` | ||
|
||
Tests in the browser | ||
|
||
```bash | ||
$ npm run test:browser | ||
``` | ||
|
||
## Building browser version | ||
|
||
```bash | ||
$ npm run build | ||
``` | ||
|
||
## Releases | ||
|
||
The `release` task will | ||
|
||
1. Run a build | ||
2. Commit the build | ||
3. Bump the version in `package.json` | ||
4. Commit the version change | ||
5. Create a git tag | ||
6. Run `git push` to `upstream/master` (You can change this with `--remote my-remote`) | ||
|
||
```bash | ||
# Major release | ||
$ npm run release-major | ||
# Minor relase | ||
$ npm run release-minor | ||
# Patch release | ||
$ npm run release | ||
``` | ||
|
||
[node.js]: https://nodejs.org/ | ||
[npm]: http://npmjs.org/ | ||
[eslint]: http://eslint.org/ | ||
[standard]: https://github.com/feross/standard |
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