Skip to content

Commit

Permalink
docs(contrib): Added CONTRIBUTING.md
Browse files Browse the repository at this point in the history
Added basic info for contributors

#83
  • Loading branch information
halfzebra committed Jan 4, 2017
1 parent b46321d commit 2d219e5
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing to Create Elm App

## Setting Up a Local Copy

1. Fork the repo and clone with `git clone [email protected]:%YOUR_USERNAME%/create-elm-app.git`

2. Run `npm install` in the root `create-elm-app` folder to install all dependencies.

3. Run `npm link` in the root `create-elm-app` folder to install local module globally.

## Submitting a Pull Request

When you have a local copy of the project up and running, create a new branch with a name, such as `patch-1`

```
git checkout -b patch-1
```

Create Elm App uses [Commitizen](https://github.com/commitizen/cz-cli) and [semantic-release](https://github.com/semantic-release/semantic-release) for release automatization.

Commit changes by running `npm run commit`

Follow the prompt and try to specify as much information as possible.

0 comments on commit 2d219e5

Please sign in to comment.