Skip to content

Commit a51494f

Browse files
authored
Merge pull request #97 from KunalKapadia/develop
Remove buggy commit msg pattern
2 parents 0d3a3ea + 75e322b commit a51494f

File tree

2 files changed

+4
-15
lines changed

2 files changed

+4
-15
lines changed

README.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ Heavily inspired from [Egghead.io - How to Write an Open Source JavaScript Libra
2929
| Debugging via [debug](https://www.npmjs.com/package/debug) | Instead of inserting and deleting console.log you can replace it with the debug function and just leave it there. You can then selectively debug portions of your code by setting DEBUG env variable. If DEBUG env variable is not set, nothing is displayed to the console. |
3030
| Promisified Code via [bluebird](https://github.com/petkaantonov/bluebird) | We love promise, don't we ? All our code is promisified and even so our tests via [supertest-as-promised](https://www.npmjs.com/package/supertest-as-promised). |
3131
| API parameter validation via [express-validation](https://www.npmjs.com/package/express-validation) | Validate body, params, query, headers and cookies of a request (via middleware) and return a response with errors; if any of the configured validation rules fail. You won't anymore need to make your route handler dirty with such validations. |
32+
| Pre-commit hooks | Runs lint and tests before any commit is made locally, making sure that only tested and quality code is committed
3233
| Secure app via [helmet](https://github.com/helmetjs/helmet) | Helmet helps secure Express apps by setting various HTTP headers. |
3334

3435
- CORS support via [cors](https://github.com/expressjs/cors)
@@ -76,23 +77,13 @@ Other gulp tasks:
7677
gulp clean
7778

7879
# Lint code with ESLint
79-
gulp lint
80+
npm run lint
81+
npm run lint:watch
8082

8183
# Default task: Wipes out dist and coverage directory. Compiles using babel.
8284
gulp
8385
```
8486

85-
##### Commit:
86-
87-
Follows [AngularJS's commit message convention](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines)
88-
```sh
89-
# Lint and execute tests before committing code.
90-
npm run commit
91-
# OR
92-
# use git commit directly with correct message convention.
93-
git commit -m "chore(ghooks): Add pre-commit and commit-msg ghook"
94-
```
95-
9687
##### Deployment
9788

9889
```sh

package.json

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
"test": "NODE_ENV=test babel-node node_modules/.bin/isparta cover _mocha -- --ui bdd --reporter spec --colors --compilers js:babel-core/register ./server/**/*.test.js",
1818
"test:watch": "npm run test -- --watch",
1919
"test:check-coverage": "npm run test && istanbul check-coverage",
20-
"commit": "git-cz",
2120
"report-coverage": "coveralls < ./coverage/lcov.info"
2221
},
2322
"repository": {
@@ -90,8 +89,7 @@
9089
"license": "MIT",
9190
"config": {
9291
"ghooks": {
93-
"pre-commit": "npm run lint && npm test",
94-
"commit-msg": "validate-commit-msg"
92+
"pre-commit": "npm run lint && npm test"
9593
},
9694
"commitizen": {
9795
"path": "./node_modules/cz-conventional-changelog"

0 commit comments

Comments
 (0)