Skip to content

Commit

Permalink
Merge pull request #162 from pdecat/docs/fix-links
Browse files Browse the repository at this point in the history
docs: fix links to commitlint and pre-commit documention
  • Loading branch information
alessandrojcm authored Sep 13, 2024
2 parents e5287c0 + 7c7c2ea commit d1f6784
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Configuration

* Create your `commitlint` config file in the repo's root, as explained in Commitlint [docs](https://commitlint.js.org/#/reference-configuration).
* Create your `commitlint` config file in the repo's root, as explained in Commitlint [docs](https://commitlint.js.org/reference/configuration.html#configuration).
* Add the following to your `.pre-commit-config.yaml`:
```
- repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
Expand All @@ -11,7 +11,7 @@
- id: commitlint
stages: [commit-msg]
```
* Add your [shared configurations](https://commitlint.js.org/#/reference-configuration?id=shareable-configuration) as a
* Add your [shared configurations](https://commitlint.js.org/reference/configuration.html#shareable-configuration) as a
dependency using the `additional_dependencies` parameter of the hooks, here we use the `@commitlint/config-angular`
as an example:
```
Expand All @@ -22,13 +22,13 @@
stages: [commit-msg]
additional_dependencies: ['@commitlint/config-angular']
```
- Install the [`commit-msg`](https://pre-commit.com/#pre-commit-for-commit-messages) hook in your project repo:
- Install the [`commit-msg`](https://pre-commit.com/#commit-msg) hook in your project repo:
```shell
pre-commit install --hook-type commit-msg
```
Note that you **need** to specify a shared configuration in order for `commitlint` to work, if `commitlint` is new to you
just use their default configuration (`@commitlint/config-conventional`). For more information, refer to their [docs](https://commitlint.js.org/#/?id=getting-started).
just use their default configuration (`@commitlint/config-conventional`). For more information, refer to their [docs](https://commitlint.js.org/guides/getting-started.html).
### Usage in Travis CI
Expand Down

0 comments on commit d1f6784

Please sign in to comment.