Skip to content

[pull] master from conventional-changelog:master #15

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
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
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ echo "your commit message here" | commitlint # fails/passes

## Checklist:

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- Go over all the following points, and put an `x` in all the boxes that apply. See the README for information on testing. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My change requires a change to the documentation.
Expand Down
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
- [License](#license)
- [Development](#development)
- [Install and run](#install-and-run)
- [Testing](#testing)
- [Publishing a release](#publishing-a-release)

---
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/reference-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand All @@ -290,7 +290,7 @@ Infinity

```js
[
'lower-case', // default
'lower-case', // lower case
'upper-case', // UPPERCASE
'camel-case', // camelCase
'kebab-case', // kebab-case
Expand Down