Contributing Guide

​

Git workflow

dev (main development branch)
├── feature/my-feature
├── feature/add-reports
├── fix/order-status-bug
└── hotfix/critical-fix

​

Branch naming

​

Workflow

1. Create a branch from dev
2. Make your changes
3. Push and create a Merge Request to dev
4. Code review and CI pipeline must pass
5. Merge into dev

git checkout dev
git pull origin dev
git checkout -b feature/my-feature

# Make changes...
git add .
git commit -m "feat: add stock transfer validation"
git push -u origin feature/my-feature

​

Commit messages

feat: add stock transfer between locations
fix: correct order total calculation with discounts
refactor: extract product service from controller
docs: add pagination documentation
test: add order creation test

​

Code style

# Check style
./vendor/bin/pint --test

# Fix style automatically
./vendor/bin/pint

​

Key conventions

• PHP 8.2+ features (enums, typed properties, named arguments)
• PSR-12 coding standard
• Strict types in new files
• No unused imports or variables
• Return types on all methods

​

Where to put code

​

Checklist before submitting

• Code passes ./vendor/bin/pint --test
• New models use KsuidTrait
• New endpoints have FormRequest validation
• New models have policies with permission checks
• Migrations are idempotent
• Translations added for en and fr
• No hardcoded company IDs — use company() helper
• Tested locally with docker compose exec app php -d memory_limit=1G artisan test --parallel --processes=4 --recreate-databases