commit-sheriff 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,14 +2,17 @@
|
|
|
2
2
|
|
|
3
3
|
Shared [Husky](https://typicode.github.io/husky/) git hooks for any project — enforces a consistent **branch naming format** and **commit message format** (ticket + type, optionally module), and runs **lint-staged** / type-check / related tests before every commit.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Quick start
|
|
6
6
|
|
|
7
7
|
```bash
|
|
8
|
+
npm i commit-sheriff
|
|
8
9
|
npx commit-sheriff init
|
|
10
|
+
npx commit-sheriff add-eslint-react # optional — TypeScript/React + module-boundary ESLint config
|
|
9
11
|
```
|
|
10
12
|
|
|
11
13
|
## Table of contents
|
|
12
14
|
|
|
15
|
+
- [Quick start](#quick-start)
|
|
13
16
|
- [Why](#why)
|
|
14
17
|
- [Requirements](#requirements)
|
|
15
18
|
- [Install](#install)
|