diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index cca22af6cb..3f26ef9948 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -36,7 +36,7 @@ echo "your commit message here" | commitlint # fails/passes ## Checklist: - + - [ ] My change requires a change to the documentation. diff --git a/README.md b/README.md index cb7336725d..de8958b03a 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ - [License](#license) - [Development](#development) - [Install and run](#install-and-run) + - [Testing](#testing) - [Publishing a release](#publishing-a-release) --- @@ -254,6 +255,17 @@ yarn start # run tests, again on change For more information on how to contribute please take a look at our [contribution guide](./.github/CONTRIBUTING.md). +### Testing + +From the project root directory, use the following commands to run the test suite + +```sh +yarn clean +yarn install +yarn build +yarn test +``` + ### Package dependency overview ![commitlint-dependencies](https://user-images.githubusercontent.com/4248851/58385093-34b79780-7feb-11e9-8f27-bffc4aca3eba.png) diff --git a/docs/reference-rules.md b/docs/reference-rules.md index d65592346e..9f60fac61c 100644 --- a/docs/reference-rules.md +++ b/docs/reference-rules.md @@ -278,7 +278,7 @@ Infinity #### subject-case -- **condition**: `subject` is in one of the cases `['sentence-case', 'start-case', 'pascal-case', 'upper-case']` +- **condition**: `subject` is in case `value` - **rule**: `always` - **value** @@ -290,7 +290,7 @@ Infinity ```js [ - 'lower-case', // default + 'lower-case', // lower case 'upper-case', // UPPERCASE 'camel-case', // camelCase 'kebab-case', // kebab-case