Gitflow Workflow

1---
2description: Gitflow Workflow Rules. These rules should be applied when performing git operations.
3---
4# Gitflow Workflow Rules
5 
6## Main Branches
7 
8### main (or master)
9- Contains production-ready code
10- Never commit directly to main
11- Only accepts merges from:
12  - hotfix/* branches
13  - release/* branches
14- Must be tagged with version number after each merge
15 
16### develop
17- Main development branch
18- Contains latest delivered development changes
19- Source branch for feature branches
20- Never commit directly to develop
21 
22## Supporting Branches
23 
24### feature/*
25- Branch from: develop
26- Merge back into: develop
27- Naming convention: feature/[issue-id]-descriptive-name
28- Example: feature/123-user-authentication
29- Must be up-to-date with develop before creating PR
30- Delete after merge
31 
32### release/*
33- Branch from: develop
34- Merge back into: 
35  - main
36  - develop
37- Naming convention: release/vX.Y.Z
38- Example: release/v1.2.0
39- Only bug fixes, documentation, and release-oriented tasks
40- No new features
41- Delete after merge
42 
43### hotfix/*
44- Branch from: main
45- Merge back into:
46  - main
47  - develop
48- Naming convention: hotfix/vX.Y.Z
49- Example: hotfix/v1.2.1
50- Only for urgent production fixes
51- Delete after merge
52 
53## Commit Messages
54 
55- Format: `type(scope): description`
56- Types:
57  - feat: New feature
58  - fix: Bug fix
59  - docs: Documentation changes
60  - style: Formatting, missing semicolons, etc.
61  - refactor: Code refactoring
62  - test: Adding tests
63  - chore: Maintenance tasks
64 
65## Version Control
66 
67### Semantic Versioning
68- MAJOR version for incompatible API changes
69- MINOR version for backwards-compatible functionality
70- PATCH version for backwards-compatible bug fixes
71 
72## Pull Request Rules
73 
741. All changes must go through Pull Requests
752. Required approvals: minimum 1
763. CI checks must pass
774. No direct commits to protected branches (main, develop)
785. Branch must be up to date before merging
796. Delete branch after merge
80 
81## Branch Protection Rules
82 
83### main & develop
84- Require pull request reviews
85- Require status checks to pass
86- Require branches to be up to date
87- Include administrators in restrictions
88- No force pushes
89- No deletions
90 
91## Release Process
92 
931. Create release branch from develop
942. Bump version numbers
953. Fix any release-specific issues
964. Create PR to main
975. After merge to main:
98   - Tag release
99   - Merge back to develop
100   - Delete release branch
101 
102## Hotfix Process
103 
1041. Create hotfix branch from main
1052. Fix the issue
1063. Bump patch version
1074. Create PR to main
1085. After merge to main:
109   - Tag release
110   - Merge back to develop
111   - Delete hotfix branch