Skip to content

Commit 36e365d

Browse files
author
bquinn
committed
adding basic contributing documentation, mostly to include publishing process in writing
1 parent 36c91be commit 36e365d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Terms
2+
3+
* Contributor: Someone who wishes to add to this code base but does not have merge and publish rights on this repository
4+
* Maintainer: Someone who adds to this code base regularly and has merge and publish rights to this repository
5+
6+
As a `Contributor`:
7+
8+
* Fork this repo
9+
* Submit a PR to the upstream
10+
11+
12+
As a `Maintainer`:
13+
14+
* Follow the same pattern as `Contributor` for submitting code changes, new features, etc
15+
* Publishing new versions of this npm package:
16+
1. Bump the `version` field of the package.json and update the changelog and commit directly to `master`
17+
2. Cut a release via Github's `releases` tab on this repository to trigger a GitHub `publish` action which will publish the latest version of this package to npmjs.org's public npm registry.

0 commit comments

Comments
 (0)