Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Fix authored Sep 9, 2017
1 parent a3c6f51 commit 0c15eea
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Contributing to `gnt` :cocktail:
Contributions all all kinds are welcome, whether it is code, issues, questions, logo design, bug-fixes, documentation, examples and more!

### New Types
You can add new types to `gnt` in one of two ways:
1. Add a new package to `/packages` and include tests and a `package.json`
2. Add a new dependency to `gnt` and expose it in `index.js`

### Before submitting a PR
1. If you are adding new logic, add or update the unit tests
2. Run `npm run lint` and `npm run test` and make sure there are no errors

0 comments on commit 0c15eea

Please sign in to comment.