Skip to content

Commit

Permalink
docs(readme): add contribution guideline
Browse files Browse the repository at this point in the history
  • Loading branch information
tusharmath committed Mar 13, 2016
1 parent 877d907 commit c010f74
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -76,3 +76,22 @@ OUTPUT {event: <event>, message: <message>}
- `DATA`: Fired every time some packet of data is SAVED.
- `TRUNCATE`: Fired once the meta info is removed from the `.mtd` file.
- `RENAME`:Fired once the file is renamed from `.mtd` to the original name.

# Contribution Guidelines
[standard]: http://standardjs.com
[commitizen]: https://github.com/commitizen/cz-cli
Before submitting a patch make sure —

0. Use `npm update` to load the latest dependencies

0. All tests are passing. If its a bug add a new test to mimic the bug.

0. Follows [Standard][standard] code style.

0. Commits are in `<type>(<scope>): <subject>` format. Where type can be — `feat` `fix` `docs` `style` `refactor` `perf` `test` `chore` `revert`.

Best practice would be to use [commitizen][commitizen] to make sure the commit is in standard format.
```
npm install commitizen -g
git cz -a
```

0 comments on commit c010f74

Please sign in to comment.