You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 9a9f64d
Browse filesBrowse the repository at this point in the historyBrowse files
docs: describe the git hooks and pull request checks in development setup
Cover the hooks pnpm install turns on, pnpm skills:check and pnpm commit:check, the skills step in CI, the warn-only Commit message and Docs check workflows, and the no-docs label.
Copy file name to clipboardExpand all lines: apps/docs/src/content/contributing/development.md
+26-2Lines changed: 26 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,6 +32,15 @@ pnpm install
32
32
33
33
`pnpm-workspace.yaml` lists `packages/*`, `examples/*` and `apps/*`, so one install covers every project.
34
34
35
+
### Git hooks
36
+
37
+
`pnpm install` sets `core.hooksPath` to `.githooks` and `commit.template` to `.gitmessage`. If you already set either one yourself, it keeps your value.
|`pre-commit`| Formats the staged files with Prettier and stages the result. It skips a file that also has unstaged changes, so hunks you left out with `git add -p` stay out of the commit. |
42
+
|`commit-msg`| Checks the message against the [commit message guidelines](https://github.com/santoshyadavdev/angular-devtools/blob/main/docs/contributing/commit-message-guidelines.md). It prints a warning and never blocks the commit. |
pnpm skills:check # Agent skills and roles in .claude/
139
+
pnpm commit:check # Commit messages on your branch
129
140
```
130
141
142
+
`pnpm skills:check` validates the frontmatter of every skill and role and checks that the files and links they mention exist. `pnpm commit:check` checks every commit on your branch that is not on `main` (it compares with `upstream/main`, then `origin/main`, then `main`).
143
+
131
144
### What CI runs
132
145
133
146
`.github/workflows/ci.yml` runs on pushes and pull requests to `main`, in this order:
|`Commit message`|`.github/workflows/commit-message.yml`| The pull request title and every commit message. The title becomes the commit on `main` when the pull request is squash merged. |
176
+
|`Docs check`|`.github/workflows/docs-check.yml`| That a change to `packages/ng-devtools/src/`, `app/src/` or the top-level files in `extension/` also changes a page in `apps/docs/src/content`. Tests don't count. |
177
+
178
+
If a code change needs no docs change, add the `no-docs` label to the pull request and say why in the description. The `Docs check` workflow then skips the warning.
0 commit comments