Skip to content

Commit a3b54f3

Browse files
committed
add contributor guide
1 parent baa233e commit a3b54f3

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CONTRIBUTING.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributor Guidelines
2+
3+
This project has automated tests which can be run with `npm test`. This will be
4+
run in Travis CI when you make a Pull Request so please try to ensure that they
5+
are passing when submitting one. If your PR adds new features please also add
6+
tests. If your PR fixes a bug, it might be helpful to add a test which would fail
7+
if the bug was re-introduced.
8+
9+
The source code of this project is also checked for coding errors and code style
10+
consistency using ESLint. You can run it with `npm run lint` to see any errors,
11+
and you can automatically fix some coding style errors using `npm run lint-fix`.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,10 @@ browserify-incremental (eg. with `--save`) to ensure that your browserify versio
143143
is locked by package.json, because browserify-incremental doesn't specify an
144144
exact browserify version.
145145

146+
## Contributing
147+
148+
Please see the [Contributor Guidelines](CONTRIBUTING.md).
149+
146150
# license
147151

148152
MIT

0 commit comments

Comments
 (0)