ื“ืœื’ ืœืชื•ื›ืŸ ื”ืจืืฉื™

Contribution Guide

How to contribute to the Ever Gauzy project.

Getting Startedโ€‹

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Create a feature branch from develop
  4. Make your changes
  5. 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โ€‹

  1. Ensure CI passes (lint, test, build)
  2. Add/update tests for changes
  3. Update documentation if needed
  4. Request review from maintainers
  5. Address feedback
  6. 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โ€‹

AreaDescription
Bug fixesFix reported issues
FeaturesNew features from roadmap
DocumentationImprove/add docs
i18nTranslation improvements
TestsAdd/improve test coverage
PerformanceOptimization work