jason/polaris-task-force
1
0
Fork 0
Code Issues Wiki Activity

docs: add conventional commit prefix rules to AGENTS.md

Browse source
This commit is contained in:
Jason Fraley 2026-09-08 13:16:16 -04:00
parent 2c8e305ff5
commit 0143c235bc
1 changed files with 7 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
AGENTS.md
View file

@ -343,6 +343,13 @@ In development, `postgresAdapter` uses `push: false` — run `bun run payload mi
- **Tailwind v4**: no `tailwind.config` — configured via `@tailwindcss/postcss` in `postcss.config.mjs` and CSS imports. Use `cn()` from `@/lib/utils` for class merging. - **Tailwind v4**: no `tailwind.config` — configured via `@tailwindcss/postcss` in `postcss.config.mjs` and CSS imports. Use `cn()` from `@/lib/utils` for class merging.
- **No em-dashes in final outputs**: never emit em-dashes (`—`, `–`) in anything you produce as a final deliverable: chat replies, commit messages, PR descriptions, docs, comments, UI copy. Replace them with a comma, semicolon, colon, or parenthetical, or split into two sentences. (Earlier bullets in this section predate the rule; new writing must comply.) - **No em-dashes in final outputs**: never emit em-dashes (`—`, `–`) in anything you produce as a final deliverable: chat replies, commit messages, PR descriptions, docs, comments, UI copy. Replace them with a comma, semicolon, colon, or parenthetical, or split into two sentences. (Earlier bullets in this section predate the rule; new writing must comply.)
### Conventional Commit prefixes
- `docs` is for documentation **files** only: changes confined to `.md` files (AGENTS.md, README.md, DEPLOYMENT.md, `docs/`). Never use `docs` for edits to source files (`.ts`/`.tsx`), even when the edit is copy-only.
- User-facing string/copy changes inside source files (UI text, labels, hints) use `chore(<scope>)` when they change no behavior. If the edit adds or alters behavior (new UI, changed flow, changed logic), use `feat` or `fix` as usual.
- Examples: `docs: restrict release version bumps and tags to main deploys` (changed AGENTS.md/README.md/DEPLOYMENT.md only) is a correct `docs` commit; `chore(opord): rename veteran tier detail to extended order` is the right form for a UI-string tweak in `OpordArena.tsx` (that commit shipped as `docs(opord)` before this rule existed; do not rewrite the pushed history).
- Trivial non-functional source edits that are not user-facing copy (formatting, comment fixes, config touches) also use `chore` (or `style` for pure formatting).
## UI components ## UI components
shadcn/ui components live in `src/components/ui/`. Use `bunx shadcn@latest add <component>` to add new ones. Frontend components in `src/components/frontend/`. Payload admin custom components referenced in `payload.config.ts` under `admin.components`. shadcn/ui components live in `src/components/ui/`. Use `bunx shadcn@latest add <component>` to add new ones. Frontend components in `src/components/frontend/`. Payload admin custom components referenced in `payload.config.ts` under `admin.components`.