Skip to content

docs(agents): explain the Trunk formatter pre-commit hook #158

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.

Sign up for GitHub

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
ss-o merged 1 commit into from
Oct 19, 2026
Merged

docs(agents): explain the Trunk formatter pre-commit hook #158

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,12 @@ Run `ctest --test-dir build -R zpmod_smoke --output-on-failure` for a quick chec
suite when it does and before a pull request. Tests are Zsh scripts in the suites under `tests/`; they use `tests/test_helpers.zsh`
and find the staged module through `ZPMOD_STAGE_MODULE_DIR`. See the [testing guide](tests/README.md).

`.trunk/trunk.yaml` enables `trunk-fmt-pre-commit`, which reformats staged C files. A commit that restores `src/` from `main`
to drop a formatting pass therefore comes out empty: to drop C changes, rebuild the branch from `main` with only the wanted
files, and check `git show --stat HEAD` before describing what a commit contains. The required Trunk check compares findings
by line, so reformatting lines that carry existing clang-tidy findings reports them as new; formatting lands together with
those fixes ([#129](https://github.com/z-shell/zpmod/issues/129)).

## Architecture

- `src/core/*`: core logic, for example `source.c` for `source-study` and the `source` overrides.
Expand Down
Loading