1.2 KiB
1.2 KiB
Contributing to ABE
Thank you for your interest in contributing to ABE!
Development Setup
- Fork and clone the repository
- Install dependencies:
npm install && cd frontend && npm install - Run migrations:
npm run db:migrate - Start dev servers:
npm run dev+cd frontend && npm run dev
Architecture Rules
Before submitting a PR, ensure your code follows these rules:
- Domain layer — No imports from
kysely,express,playwrightor any infrastructure - Cross-module communication — Only via EventBus (no direct module imports)
- Use cases — Must return
Result<T, E>, never throw business errors - No
any— All new code must have explicit TypeScript types
Making Changes
- Create a feature branch from
main - Write tests for new functionality
- Run the full verification:
npm run build && cd frontend && npm run build && cd .. && npm run test - Submit a pull request
Commit Messages
Follow the pattern: feat(module): description or fix(module): description
Reporting Issues
Please use GitHub Issues with:
- Steps to reproduce
- Expected vs actual behavior
- ABE version and Node.js version