Skip to content

Commit e345322

Browse files
authored
Merge pull request #4 from kethinov/more-docs
Documentation
2 parents 67200c6 + f7f6d5d commit e345322

3 files changed

Lines changed: 34 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
## Next version
4+
5+
- Put your changes here...
6+
7+
## 0.1.0
8+
9+
- Initial version.
10+

CONTRIBUTING.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# How to contribute
2+
3+
## Before opening a pull request
4+
5+
- Be sure all tests pass: `npm t`.
6+
- Ensure 100% code coverage and write new tests if necessary: `npm run coverage`.
7+
- Add your changes to `CHANGELOG.md`.
8+
9+
## Release process
10+
11+
If you are a maintainer of this module, please follow the following release procedure:
12+
13+
- Merge all desired pull requests into master.
14+
- Bump `package.json` to a new version and run `npm i` to generate a new `package-lock.json`.
15+
- Alter CHANGELOG "Next version" section and stamp it with the new version.
16+
- Paste contents of CHANGELOG into new version commit.
17+
- Open and merge a pull request with those changes.
18+
- Tag the merge commit as the a new release version number.
19+
- Publish commit to npm.

LICENSE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
License
2+
===
3+
4+
All original code in this project is licensed under the [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/). Commercial and noncommercial use is permitted with attribution.
5+

0 commit comments

Comments
 (0)