Skip to content

Commit

Permalink
docs(readme): Add commit message guidelines to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kunalkapadia committed Feb 12, 2016
1 parent 1a39e63 commit 1fcc16f
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,6 @@ npm test (or gulp mocha)
gulp mocha --code-coverage-reporter text
```

Commit:
```sh
# Lint and execute tests before committing code. Uses commitizen to follow commit message convention.
npm run commit
```

Other gulp tasks:
```sh
# Wipe out dist and coverage directory
Expand All @@ -83,6 +77,17 @@ gulp lint
gulp
```

##### Commit:

Follows [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines)
```sh
# Lint and execute tests before committing code.
npm run commit
# OR
# use git commit directly with correct message convention.
git commit -m "chore(ghooks): Add pre-commit and commit-msg ghook"
```

## Logging

Universal logging library [winston](https://www.npmjs.com/package/winston) is used for logging. It has support for multiple transports. A transport is essentially a storage device for your logs. Each instance of a winston logger can have multiple transports configured at different levels. For example, one may want error logs to be stored in a persistent remote location (like a database), but all logs output to the console or a local file. We just log to the console for simplicity, you can configure more transports as per your requirement.
Expand Down

0 comments on commit 1fcc16f

Please sign in to comment.