Skip to content

Commit 39f2c9f

Browse files
Meekohimike-unearth
authored andcommitted
Update "Version Control Conventions" in CONTRIBUTING.md (mapbox#9255)
1 parent c23fd8d commit 39f2c9f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

CONTRIBUTING.md

+9
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,15 @@ The conventions for module exports are:
135135

136136
* We use [rebase merging](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) (as opposed to [basic merging](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging#Basic-Merging)) to merge branches
137137

138+
Here is a recommended way to get setup:
139+
1. Fork this project
140+
2. Clone your new fork, `git clone git@github.com:GithubUser/mapbox-gl-js.git`
141+
3. `cd mapbox-gl-js`
142+
4. Add the Mapbox repository as an upstream repository: `git add remote upstream git@github.com:mapbox/mapbox-gl-js.git`
143+
5. Create a new branch `git checkout -b your-branch` for your contribution
144+
6. Write code, open a PR from your branch when you're ready
145+
7. If you need to rebase your fork's PR branch onto master to resolve conflicts: `git fetch upstream`, `git rebase upstream/master` and force push to Github `git push --force origin your-branch`
146+
138147
## Documentation Conventions
139148

140149
See [`README.md`](https://github.com/mapbox/mapbox-gl-js-docs/blob/publisher-production/README.md) from [`mapbox-gl-js-docs`](https://github.com/mapbox/mapbox-gl-js-docs/).

0 commit comments

Comments
 (0)