docs(agents): add setup, testing, and commit conventions #81

Claude · 2026-07-23T17:53:23Z

Claude commented

2026-07-23 17:53:23 +00:00

Summary

AGENTS.md had no Setup, Testing instructions, or Commit/PR conventions sections, despite the repo having verifiable, non-obvious conventions for all three.
Added:
- Setup — pre-commit install -t pre-commit -t pre-push -t commit-msg is required because .pre-commit-config.yaml has no default_install_hook_types; a plain pre-commit install silently skips the commit-msg and pre-push stages.
- Testing instructions — bash tests/run-tests.sh runs every test-*.sh script plus the bats suite; bats submodules self-init on first run.
- Commit / PR conventions — Conventional Commits enforced via conventional-pre-commit; pre-push also runs the full test suite and scripts/check-manifests.sh.

Verification

Ran core:agentsmd-audit against the updated file: PASS with 2 informational notes (no code-style / security-considerations sections — deliberate, since nothing repo-specific beyond the existing linters and governance.md applies).
Local pre-push hooks (test suite, manifest checks, marketplace validation) passed on push.

## Summary - `AGENTS.md` had no Setup, Testing instructions, or Commit/PR conventions sections, despite the repo having verifiable, non-obvious conventions for all three. - Added: - **Setup** — `pre-commit install -t pre-commit -t pre-push -t commit-msg` is required because `.pre-commit-config.yaml` has no `default_install_hook_types`; a plain `pre-commit install` silently skips the `commit-msg` and `pre-push` stages. - **Testing instructions** — `bash tests/run-tests.sh` runs every `test-*.sh` script plus the bats suite; bats submodules self-init on first run. - **Commit / PR conventions** — Conventional Commits enforced via `conventional-pre-commit`; pre-push also runs the full test suite and `scripts/check-manifests.sh`. ## Verification - Ran `core:agentsmd-audit` against the updated file: **PASS with 2 informational notes** (no code-style / security-considerations sections — deliberate, since nothing repo-specific beyond the existing linters and `governance.md` applies). - Local pre-push hooks (test suite, manifest checks, marketplace validation) passed on push.

Claude added 1 commit 2026-07-23 17:53:23 +00:00

docs(agents): add setup, testing, and commit conventions f86f0b57bc

AGENTS.md had no Setup, Testing, or Commit/PR sections even though the
repo has verifiable, non-obvious conventions for all three: pre-commit
hooks span three stages with no default_install_hook_types set (a plain
`pre-commit install` silently skips commit-msg/pre-push), tests/run-tests.sh
runs the full suite, and conventional-pre-commit enforces Conventional
Commits. Agents working in this repo had no way to discover these without
reading the pre-commit config and scripts directly.

Defame1297 approved these changes 2026-07-23 17:53:42 +00:00

Defame1297 merged commit 638e60846b into main

2026-07-23 17:53:45 +00:00

Defame1297 deleted branch docs/agentsmd-setup-testing-conventions

2026-07-23 17:53:45 +00:00

Defame1297 referenced this issue from a commit

2026-07-23 17:53:46 +00:00

Merge pull request 'docs(agents): add setup, testing, and commit conventions' (#81) from docs/agentsmd-setup-testing-conventions into main

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: Defame1297/holocron#81