Skip to content
This repository has been archived by the owner on Jul 4, 2018. It is now read-only.

Commit

Permalink
Adds a contributing.md section which fixes #18
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Hoogeveen committed Mar 28, 2017
1 parent 0fed7ac commit 106d47c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions 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/`

0 comments on commit 106d47c

Please sign in to comment.