Alex Galarce
c5af046cde
Feature/improve logging docs * Enhance PerFileHandler documentation and functionality for improved logging context management * Add more docuementation * Update logging_utils.py documentation for clarity and usage examples * Enhance logging comments for clarity on per-file logging setup and concurrent processing * Enhance logging comments for clarity on per-file logging context and its implications 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.