1 Development Processes
1.1 Git Workflow
1.1.1 Branch Naming Convention
feature/description- New featuresbugfix/description- Bug fixes
hotfix/description- Critical production fixesdocs/description- Documentation updates
1.1.2 Code Review Process
- Create feature branch from
main - Make changes with descriptive commits
- Open PR with clear title and description
- Request review from at least one team member
- Address feedback and re-request review
- Merge after approval
1.1.3 Commit Message Format
type(scope): brief description
Longer explanation if needed
- Bullet points for specifics
- Reference issues: Fixes #123
1.2 Testing Standards
1.2.1 Required Tests
- Unit tests for all business logic
- Integration tests for API endpoints
- End-to-end tests for critical user flows
1.2.2 Running Tests
# Run all tests
npm test
# Run with coverage
npm run test:coverage
# Run specific test file
npm test -- --grep "specific test"1.3 Code Standards
1.3.1 JavaScript/TypeScript
- Use ESLint configuration in
.eslintrc.js - Prettier for formatting
- TypeScript for all new code
1.3.2 Documentation
- JSDoc comments for functions and classes
- README files for each major component
- API documentation using OpenAPI/Swagger