Skip to content

chore(linting): add commitlint prompt and hook #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 11, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing to Angular Redux

## Package Management

This repo utilizes [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) for package management. Please install and use [Yarn](https://yarnpkg.com/en/docs/getting-started) as your npm client for this project. The npm cli is not supported for package installation.

## Commit Message Guidelines

We follow the [Conventional Commits](https://conventionalcommits.org/) guidelines. These are enforced through the use of [commitlint](http://marionebl.github.io/commitlint). If you would like a more interactive way of formatting your commit messages, run `yarn commit` once your changes are staged.
3 changes: 3 additions & 0 deletions commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
};
10 changes: 8 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,16 @@
"packages/*"
],
"scripts": {
"build": "lerna run build",
"lint": "lerna run lint"
"build": "lerna run build",
"lint": "lerna run lint",
"commit": "commit",
"commitmsg": "commitlint -E GIT_PARAMS"
},
"devDependencies": {
"@commitlint/cli": "^7.0.0",
"@commitlint/config-conventional": "^7.0.1",
"@commitlint/prompt-cli": "^7.0.0",
"husky": "^0.14.3",
"lerna": "2.11.0"
}
}
Loading