Git Guideline
Git Workflow
We utilize a slightly modified version of GitHub Flow as our branching strategy to streamline our development process and enhance collaboration. This approach ensures that our main branch always contains production-ready code and that new features, fixes, and updates are managed in dedicated branches.
For a detailed explanation of our specific practices, modifications, and guidelines, please refer to our full Git Agreement Document.
Commit Messages
We adhere to the Conventional Commits specification across all our repositories. This practice helps automate the changelog generation, streamline the CI/CD process, and maintain consistency across projects.
How It Works
Frontend: A husky hook is set up to enforce Conventional Commits, ensuring every commit message follows the standard format.
Backend: Commit messages trigger specific CI/CD actions, making it crucial to follow the conventions accurately.
For those who prefer an assisted approach, we have commitizen installed. You can create commits using the command:
yarn commitTampermonkey Userscript for PRs (onboarding)
When PRing between two non-master branches, you must add a prefix to the PR commit message. If you don’t, CI/CD will stop working. We made a userscript to automate the process so you won’t forget.
Install Tampermonkey
Install the userscript