Michael McGuinness
33 lines
979 B
Markdown
33 lines
979 B
Markdown
# Branching and Release Management Guide
|
|
|
|
## Overview
|
|
|
|
This guide outlines the naming conventions, branching strategy, and merging process for our Git repository.
|
|
|
|
## Branch Naming Conventions
|
|
|
|
- **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`
|
|
|
|
## ....
|
|
|
|
## Branching Strategy
|
|
|
|
### Creating Branches
|
|
|
|
1. Create a feature branch from `main` using the appropriate naming convention.
|
|
2. Create a small and complete change. `main` must always have deployable code.
|
|
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.
|
|
|
|
## Refer to the branching guide in Confluence for more info on this
|
|
|
|
---
|
|
|
|
This guide ensures that all team members follow the best practices for branch management and releases. |