-
Notifications
You must be signed in to change notification settings - Fork 0
Coding Conventions
Juliet Shin edited this page May 16, 2025
·
6 revisions
All development must follow a mobile-first
approach.
As the codebase grows, testing ensures features work as expected and prevents regressions. We use:
- React Testing Library with Jest for unit tests.
- Cypress for functional (end-to-end) testing.
- Minimum 85% test coverage is required.
- All unit tests must pass before submitting a PR.
- Include accessibility tests using jest-axe.
- Build for both mobile and desktop devices.
- Follow the style guidelines in
app/[locale]/styleguide
. - Use Sass and CSS Modules to scope styles and avoid collisions.
- Code formatting is enforced via
.editorconfig
.
We follow a simple branching model:
- main: stable production-ready code
- development: active development (features, bug fixes)
Currently all feature and bug-fix branches should branch off development.
To submit a PR, branch from development and ensure the following criteria are met:
✅ Manual testing is complete
✅ Works on mobile and desktop
✅ Works in all supported browsers:
- Chrome
- Firefox
- Safari
- Microsoft Edge
✅ Unit tests:
- Cover new functionality (≥ 85% coverage)
- All existing tests pass
✅ Accessibility: