Skip to content

Commit b22c218

Browse files
committed
chore: update CONTRIBUTING.md for new git workflow
1 parent 6764b4f commit b22c218

File tree

1 file changed

+11
-35
lines changed

1 file changed

+11
-35
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,11 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
6969
7070
5. Create a branch for local development:
7171
```bash
72-
git checkout -b name-of-your-bugfix-or-feature
72+
git checkout -b task/what-you-are-doing
7373
```
74+
`task` can be any of the following: feature, bugfix, hotfix, release, chore, refactor, test, docs, ci, build, experiment, and perf.
75+
76+
`feature` is for new features, `bugfix` for fixing bugs, `hotfix` for urgent production fixes, `release` for prepping releases, `chore` for maintenance tasks, `refactor` for code restructuring, `test` for test changes, `docs` for documentation updates, `ci` and `build` for pipeline or build config, `experiment` for prototypes, and `perf` for performance improvements.
7477
7578
6. Make your changes. Don't forget to add tests!
7679

@@ -93,10 +96,11 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
9396
```bash
9497
git add .
9598
git commit -m "Your detailed description of your changes."
96-
git push origin name-of-your-bugfix-or-feature
99+
git push origin task/what-you-are-doing
97100
```
98101

99102
9. Submit a pull request through the GitHub website.
103+
- When merging to dev, always use "Rebase and merge" option
100104

101105
## Git Workflow
102106

@@ -114,44 +118,16 @@ Ready to contribute? Here's how to set up `bbox_visualizer` for local developmen
114118
3. Create a Pull Request from your feature branch to dev
115119

116120
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+
- Always use "Create a merge commit" option when merging to master
122+
- This would mean master will be 1 commit ahead of dev
121123

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:
124+
5. To reconcile dev and master, do the following.
130125
```bash
131-
# Switch to dev branch
132126
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"
127+
git pull origin master
144128
git push origin dev
145129
```
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
130+
This will bring that merge commit into dev too
155131

156132
## Pull Request Guidelines
157133

0 commit comments

Comments
 (0)