Files
Aseret_Bank/CONTRIBUTING.md
2026-02-09 21:51:31 -08:00

71 lines
1.2 KiB
Markdown

# Contributing to Aseret Bank Platform
## Development Workflow
1. **Clone the repository**
```bash
git clone <repository-url>
cd Aseret_Bank
```
2. **Run setup script**
```bash
pnpm setup
```
Or manually:
```bash
pnpm install
pnpm db:generate
pnpm db:migrate
```
3. **Start development servers**
```bash
pnpm dev
```
## Code Style
- Use TypeScript for all new code
- Follow existing code patterns
- Run linter before committing: `pnpm lint`
- Format code: `pnpm format` (backend) or `pnpm --filter frontend format`
## Database Changes
1. Modify `backend/prisma/schema.prisma`
2. Create migration: `pnpm db:migrate`
3. Generate client: `pnpm db:generate`
## Testing
```bash
# Run all tests
pnpm test
# Watch mode
pnpm --filter backend test:watch
# Coverage
pnpm --filter backend test:coverage
```
## Commit Messages
Follow conventional commits:
- `feat:` New feature
- `fix:` Bug fix
- `docs:` Documentation
- `style:` Formatting
- `refactor:` Code restructuring
- `test:` Tests
- `chore:` Maintenance
## Pull Request Process
1. Create a feature branch
2. Make your changes
3. Ensure tests pass
4. Update documentation if needed
5. Submit PR with clear description