Contribution Guide
How to contribute to the Ever Gauzy project.
Getting Startedโ
- Fork the repository on GitHub
- Clone your fork locally
- Create a feature branch from
develop - Make your changes
- Submit a Pull Request
Development Setupโ
git clone https://github.com/YOUR_USERNAME/ever-gauzy.git
cd ever-gauzy
yarn install
yarn start:api # Terminal 1
yarn start # Terminal 2
Branch Namingโ
feature/SHORT-DESCRIPTION
bugfix/SHORT-DESCRIPTION
hotfix/SHORT-DESCRIPTION
docs/SHORT-DESCRIPTION
Commit Messagesโ
Follow Conventional Commits:
feat: add employee avatar upload
fix: resolve time logging timezone bug
docs: add API quickstart tutorial
refactor: extract time service from controller
Pull Request Processโ
- Ensure CI passes (lint, test, build)
- Add/update tests for changes
- Update documentation if needed
- Request review from maintainers
- Address feedback
- PR is merged into
develop
Code Styleโ
- Follow existing patterns
- Use TypeScript strict mode
- DTOs for all API input validation
- Multi-ORM decorators for entities
- Permissions guards on all endpoints
Areas for Contributionโ
| Area | Description |
|---|---|
| Bug fixes | Fix reported issues |
| Features | New features from roadmap |
| Documentation | Improve/add docs |
| i18n | Translation improvements |
| Tests | Add/improve test coverage |
| Performance | Optimization work |
Related Pagesโ
- Git Workflow โ branching model
- Code Review Checklist โ PR review
- Development Guide โ setup guide