2024-05-24 16:53:54 -05:00
|
|
|
# Branching and Release Management Guide
|
|
|
|
|
|
|
|
|
|
## Overview
|
|
|
|
|
|
|
|
|
|
This guide outlines the naming conventions, branching strategy, and merging process for our Git repository.
|
|
|
|
|
|
|
|
|
|
## Branch Naming Conventions
|
|
|
|
|
|
2024-09-25 11:26:34 +01:00
|
|
|
- **Feature Branch**: `feature/<name>`
|
|
|
|
|
- Example: `feature/add_build_stage`
|
|
|
|
|
- **Bugfix Branch**: `bugfix/<name>`
|
|
|
|
|
- Example: `bugfix/pages_duplication`
|
|
|
|
|
- **Hotfix Branch**: `hotfix/<name>`
|
|
|
|
|
- Example: `hotfix/deployment_failure`
|
2024-09-24 18:40:06 +01:00
|
|
|
|
|
|
|
|
## ....
|
2024-05-24 16:53:54 -05:00
|
|
|
|
|
|
|
|
## Branching Strategy
|
|
|
|
|
|
2024-09-24 18:40:06 +01:00
|
|
|
### Creating Branches
|
2024-05-24 16:53:54 -05:00
|
|
|
|
2024-09-25 11:26:34 +01:00
|
|
|
1. Create a feature branch from `main` using the appropriate naming convention.
|
2024-09-25 12:23:27 +01:00
|
|
|
2. Create a small and complete change. `main` must always have deployable code.
|
2024-09-25 11:26:34 +01:00
|
|
|
3. Create a Pull Request back to `main`.
|
|
|
|
|
4. Ensure all checks have passed.
|
|
|
|
|
5. Merge new code.
|
|
|
|
|
6. Ensure the functionality is verified in the dev environment.
|
2024-05-24 16:53:54 -05:00
|
|
|
|
|
|
|
|
## Refer to the branching guide in Confluence for more info on this
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2024-09-24 18:40:06 +01:00
|
|
|
This guide ensures that all team members follow the best practices for branch management and releases.
|