Skip to content

Commit ed075b6

Browse files
committed
Add git workflow instructions
1 parent 4f816cf commit ed075b6

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

CONTRIBUTING.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,61 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
9898

9999
9. Submit a pull request through the GitHub website.
100100

101+
## Git Workflow
102+
103+
### Feature Development
104+
105+
1. Create feature branch from dev:
106+
```bash
107+
git checkout dev
108+
git pull origin dev
109+
git checkout -b name-of-your-bugfix-or-feature
110+
```
111+
112+
2. Make your changes and follow the code quality steps above (formatting, linting, testing)
113+
114+
3. Create a Pull Request from your feature branch to dev
115+
116+
4. After your feature PR is merged to dev, create a PR from dev to master:
117+
- Always use "Rebase and merge" option when merging to master
118+
- This keeps the history clean and linear
119+
120+
### Syncing Branches
121+
122+
If GitHub shows that branches are out of sync or you can't use "Rebase and merge":
123+
124+
1. Create a PR from master to dev on GitHub:
125+
- Base branch: `dev`
126+
- Compare branch: `master`
127+
- Title: "Sync dev with master"
128+
129+
2. If there are conflicts, resolve them locally:
130+
```bash
131+
# Switch to dev branch
132+
git checkout dev
133+
134+
# Get latest changes
135+
git fetch origin
136+
137+
# Try to merge master (this will show conflicts)
138+
git merge origin/master
139+
140+
# Resolve conflicts in your editor
141+
# Then commit the resolved changes
142+
git add .
143+
git commit -m "Resolve conflicts from master sync"
144+
git push origin dev
145+
```
146+
147+
3. Merge the PR on GitHub once conflicts are resolved
148+
149+
This workflow:
150+
- Maintains PR history for all changes
151+
- Makes branch synchronization trackable
152+
- Provides clear context for conflict resolutions
153+
- Keeps main development in dev branch
154+
- Maintains clean history in master
155+
101156
## Pull Request Guidelines
102157
103158
Before you submit a pull request, check that it meets these guidelines:

0 commit comments

Comments
 (0)