Workflow

Git Branching Strategy

Refer to the GitFlow branching strategy.

There are 2 permanent branches meaning that are always available:

main (default): Corresponds to the production ready environment.
develop: Corresponds to the develop environment and is used to integrate multiple features at once.
Feature Branches: Short lived branches that are used as an isolated environment to develop new features. Feature branches are a part of the preview environment.

Start by creating a feature branch off of the develop branch using git checkout -b feature/
Implement your feature on this branch and push the code when done.
Create a pull request and review the changes on Github.
Once the Github actions succeed and your code has been peer reviewed, merge the code into develop.
Whenever a new release is ready, merge the develop branch into main.

🔧 Common Feature Branch Prefixes:

Prefix	Purpose	Example
`feature/`	Used for new features or enhancements.	`feature/user-authentication`
`bugfix/`	Used for fixing non-critical bugs found during development.	`bugfix/fix-login-redirect`
`hotfix/`	Used for urgent fixes to production (branched off main).	`hotfix/payment-timeout`
`chore/`	Used for maintenance tasks or non-functional changes (e.g. updating dependencies, linting, configs).	`chore/update-dependencies`
`refactor/`	Used for improving or restructuring code without changing functionality.	`refactor/claim-service`
`test/`	Used for adding or improving tests.	`test/add-flight-delay-tests`
`docs/`	Used for documentation changes.	`docs/update-readme`
`ci/`	Used for continuous integration or pipeline changes.	`ci/github-actions-cache`