From 0c15eea97f6a0b8ca5ab76a6ab0f894afb608285 Mon Sep 17 00:00:00 2001 From: Michael Fix Date: Sat, 9 Sep 2017 16:45:04 -0700 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..384d3e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -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