Michael McGuinness
5928ee0116
Feature/add dotenv * transferred sensitive information to .env file from src/config.py * replace model IDs, AWS account info * Merge remote-tracking branch 'origin/main' into feature/add-dotenv * add explanatory comment * Merge remote-tracking branch 'origin/main' into feature/add-dotenv * remove tests that were just for local Approved-by: Katon Minhas
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
- Example:
- Bugfix Branch:
bugfix/<name>- Example:
bugfix/pages_duplication
- Example:
- Hotfix Branch:
hotfix/<name>- Example:
hotfix/deployment_failure
- Example:
....
Branching Strategy
Creating Branches
- Create a feature branch from
mainusing the appropriate naming convention. - Create a small and complete change.
mainmust always have deployable code. - Create a Pull Request back to
main. - Ensure all checks have passed.
- Merge new code.
- 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.