From 106d47c51cef565d3a20bac902836c49b03352cd Mon Sep 17 00:00:00 2001 From: Jan Hoogeveen Date: Tue, 28 Mar 2017 10:48:30 +0200 Subject: [PATCH] Adds a contributing.md section which fixes #18 --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34f936d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# How to Contribute + +Found a bug? See something we can do better? Let us know by [opening an issue](https://github.com/cleverfranke/cf-kyt-starter-universal-redux/issues) on Github. + +### Submitting a PR + +Please make sure all PRs are: + +1. linted (npm run lint) +2. tested (npm run test) +3. Connected to an issue + +### Testing local starter-kyt changes + +To test setting up/installing local starter-kyts, you need to specify the `--local-path` option. This allows you to install a starter-kyt locally by copying rather than cloning from git. Now you can make changes to the codebase in your own branch or fork and init a new app locally to test if the starter-kyt is working as intended. + +`kyt-cli setup -d my-kyt-app --local-path ./cf-kyt-starter-universal-redux/`