9b2966304d
- Add AGENTS.md with build commands, code style guidelines, and conventional commits - Add Makefile for common development tasks (build, dev, test, lint, etc.) - Include git commit guidelines following Conventional Commits specification - Provide comprehensive development workflow documentation
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
# Agent Guidelines
|
|
|
|
## Build Commands
|
|
- `bun run build` - Build the project (runs typecheck first)
|
|
- `bun run dev` - Development mode with hot reload
|
|
- `bun run test` - Run all tests
|
|
- `bun run lint` - Run ESLint on TypeScript files
|
|
- `bun run typecheck` - Run TypeScript type checking without emitting
|
|
|
|
## Git Commit Guidelines
|
|
Follow Conventional Commits specification: https://www.conventionalcommits.org/en/v1.0.0/
|
|
Format: `<type>[optional scope]: <description>`
|
|
Types: feat, fix, docs, style, refactor, test, chore, perf, ci, build
|
|
Examples: `feat(cli): add session management command`, `fix(db): handle null values in queries`
|
|
|
|
## Code Style Guidelines
|
|
- Use TypeScript with strict mode enabled (noImplicitAny: false, strictNullChecks: false)
|
|
- Import style: ES6 imports with `import { X } from './path'` for named exports
|
|
- Use `@/*` path alias for src directory imports
|
|
- Naming: camelCase for variables/functions, PascalCase for classes/interfaces
|
|
- File structure: Organize by domain (cli/, database/, models/, services/, templates/)
|
|
- Error handling: Use try/catch blocks, log errors with logger utility
|
|
- Database: Use SQLite with prepared statements, map rows to interfaces
|
|
- CLI: Use Commander.js for command structure, chalk for colored output
|
|
- Date handling: Use moment.js for date formatting/manipulation
|
|
- UUID generation: Use uuid v4 for IDs
|
|
- No explicit return types required (inferred)
|
|
- Prefer const over let, avoid var
|
|
- Use Bun runtime features where appropriate |