olek/AI_template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: add commit-docs-reminder hook to enforce checklist before commits

Browse Source 
Adds a PreToolUse Bash hook that reminds AI agents to verify
status-update-checklist.md before running git commit. Also adds
the corresponding constraint to RULES.md section 3.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
olekhondera
2026-02-15 07:44:06 +02:00
parent 432313ebcd
commit d9b2b8ffc8
4 changed files with 45 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
DOCS.md
View File

@@ -5,6 +5,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
---
## Documentation Languages
- Technical docs: English (`docs/` and subfolders).
- Repository summary: `README.md` (English).
New documents should be added in English unless noted.
@@ -14,6 +15,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
## Documentation Structure (root: `docs/`)
### 1) General Project Docs
- `docs/archetypes.md` — product archetypes and optional modules; pick what applies.
- `docs/project-overview.md` — goals, target users, chosen archetype, key flows (pick relevant), non-functional requirements.
- `docs/phases-plan.md` — Phase 0–4 plan with tasks across product, frontend, backend, infra, data/LLM.
@@ -21,10 +23,12 @@ Technical index for developers and AI agents. Use this as the entry point to all
- `docs/dev-setup.md` — local/CI setup once code exists.
### 1c) Architecture Decision Records (`/docs/adr`)
- `docs/adr/README.md` — how ADRs work.
- `docs/adr/0000-template.md` — ADR template.
### 1b) LLM / AI System (`/docs/llm`)
- `docs/llm/prompting.md` — prompt structure, versioning, output schemas.
- `docs/llm/evals.md` — evaluation strategy, datasets, regression gates.
- `docs/llm/safety.md` — privacy, injection defenses, `reasoning_trace` policy.
@@ -32,6 +36,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
- `docs/llm/rag-embeddings.md` — RAG/embeddings design and evaluation.
### 2) Frontend (`/docs/frontend`)
- `docs/frontend/overview.md` — frontend scope and key user journeys (depends on archetype/modules).
- `docs/frontend/architecture.md` — **canonical, locked frontend decisions** (after Phase 1).
- `docs/frontend/FRONTEND_ARCHITECTURE_PLAN.md` — working architecture notes; **archive/delete after Phase 1**.
@@ -39,6 +44,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
- `docs/frontend/seo-performance.md` — performance and SEO recommendations.
### 3) Backend (`/docs/backend`)
- `docs/backend/overview.md` — backend scope (integrations, AI capability, optional pipelines/approvals/billing).
- `docs/backend/architecture.md` — **canonical, locked backend decisions** (after Phase 1).
- `docs/backend/api-design.md` — API resources and conventions (entities, rules, approvals, reports, billing, events).
@@ -46,6 +52,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
- `docs/backend/payment-flow.md` — payment integration (provider-agnostic template; single source of truth for payment flows and webhooks).
### 4) Examples (`/docs/examples`)
- `docs/examples/RECOMMENDATIONS-example.md` — filled-in example of `RECOMMENDATIONS.md` for a compliance classifier (Archetype C).
---
@@ -95,6 +102,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
- `.claude/hooks/bash-firewall.sh` — blocks destructive commands (`rm -rf /`, `git reset --hard`, etc.).
- `.claude/hooks/post-edit-format.sh` — auto-formats files with Prettier after edits.
- `.claude/hooks/audit-log.sh` — logs all Bash commands with timestamp to `audit.log`.
- `.claude/hooks/commit-docs-reminder.sh` — reminds to check `status-update-checklist.md` before `git commit`.
- `.claude/settings.json` — hooks configuration (also: Notification, SessionStart compact context).
## GitHub Templates (`/.github`)
@@ -107,6 +115,7 @@ Technical index for developers and AI agents. Use this as the entry point to all
---
## How to Use This Index
- **New to the project:** read `project-overview.md` and `phases-plan.md` first.
- **Designing features:** use frontend/backend architecture docs plus API/security/payment flow specs.
- **Expanding docs:** add new English `*.md` files under `docs/` and update this index with links.