Skip to content

Commit 400f700

Browse files
committed
docs(agent): require Conventional Commits in contribution guide
1 parent 5c7aa8f commit 400f700

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

AGENT.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# SPDX-FileCopyrightText: 2026 David Rabkin
2+
# SPDX-License-Identifier: 0BSD
3+
4+
# AGENT
5+
6+
Purpose: quick operating notes for humans and automation working in this repo.
7+
8+
## Project
9+
- Name: `toolbox`
10+
- Language: POSIX shell (`#!/bin/sh`) scripts in `app/`
11+
- Build/lint entrypoint: `redo lint` (via `all.do` / `lint.do`)
12+
13+
## Repo Layout
14+
- `app/`: executable utilities
15+
- `cfg/`: configuration files used by scripts
16+
- `*.do`: `redo` build/lint tasks
17+
- `README.adoc`: user-facing docs
18+
19+
## Conventions
20+
- Keep scripts POSIX-friendly for `sh`.
21+
- Use `shellcheck` + `shfmt` compatible style.
22+
- Preserve SPDX headers in edited files.
23+
- Use Conventional Commits for commit subjects (for example: `fix: ...`,
24+
`style: ...`, `chore: ...`).
25+
- Prefer minimal, focused commits.
26+
27+
## Common Commands
28+
- Run lint: `redo lint`
29+
- Run shell syntax check on all apps:
30+
`for f in app/*; do sh -n "$f"; done`
31+
32+
## Safety
33+
- Avoid destructive git/history operations unless explicitly requested.
34+
- Do not rewrite unrelated files.

0 commit comments

Comments
 (0)