sidecar-cli 0.1.0-rc.1 → 0.1.1-beta.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 +12 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -168,7 +168,18 @@ Optional local enforcement:
|
|
|
168
168
|
npm run install:hooks
|
|
169
169
|
```
|
|
170
170
|
|
|
171
|
-
This
|
|
171
|
+
This is optional and per-repository clone. `sidecar init` does not install git hooks automatically.
|
|
172
|
+
|
|
173
|
+
This installs a pre-commit guard that checks staged non-doc code changes.
|
|
174
|
+
If staged code changes are present, commit is blocked unless both are recorded since the last commit:
|
|
175
|
+
|
|
176
|
+
- a `worklog` event
|
|
177
|
+
- a `summary refresh` event
|
|
178
|
+
|
|
179
|
+
The guard command is:
|
|
180
|
+
|
|
181
|
+
- `npm run sidecar:reminder -- --staged --enforce`
|
|
182
|
+
|
|
172
183
|
If a pre-commit hook already exists, Sidecar will not overwrite it unless you run:
|
|
173
184
|
|
|
174
185
|
```bash
|