Processes
Development Workflow
Git branching conventions, Conventional Commits, and code review criteria.
Development Workflow
Every code change follows a structured lifecycle from feature ticket to production deployment.
Git Branch Naming
Branches should be named using descriptive prefixes followed by the ticket key and a short kebab-case description:
feature/ENG-1042-user-profile-avatar
bugfix/ENG-902-fix-token-refresh-leak
chore/ENG-880-upgrade-nextjs-dependenciesConventional Commits
We follow the Conventional Commits specification:
feat:A new user-facing featurefix:A bug fixdocs:Documentation-only changesrefactor:Code restructuring without functional changestest:Adding or refactoring automated testsperf:Performance optimizations
Example commit:
git commit -m "feat(auth): add hardware security key WebAuthn support"Pull Request Checklist
Before marking a PR as "Ready for Review", ensure:
- All automated GitHub Actions CI tests pass.
- TypeScript compiles cleanly with zero warnings or errors.
- Documentation has been added or updated in
content/docs/. - At least one peer review approval from a codeowner.
Was this page helpful?
Let us know how we can make our documentation better.
Edit on GitHub
Last updated on