- Follow conventional commits format
- Refactoring should be in their own commits and not combined with features/fixes
- Add a description of
Closes #123
into the PR comment, which will automatically close the issue when the PR merges - Don't repeat the issue number or title in the git commit message, the commit message should stand alone
- Use merge policy to include a commit that links the PR back to multiple commits.
- Use typescript over javascript a) If you need to update a javascript file, first migrate it typescript in a single commit, and then layer on changes
- Add storybooks for new components
- Avoid deeply nested folder structures and
index.tsx
files as they make code navigation/search harder - Run eslint and tests before creating a PR
- Avoid mixing styling and advanced data manipulation in the same component
- Avoid duplicating styles, create a component instead
- All http requests should use axios and should be in the
src/api
directory only