Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update CONTRIBUTING.md #9255

Merged
merged 4 commits into from
Feb 6, 2020
Merged

Update CONTRIBUTING.md #9255

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9fbb93a
Update CONTRIBUTING.md
Meekohi Feb 1, 2020
6103fdf
Update CONTRIBUTING.md
Meekohi Feb 4, 2020
5578678
Update CONTRIBUTING.md
Meekohi Feb 4, 2020
596b798
Update CONTRIBUTING.md
Meekohi Feb 5, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,15 @@ The conventions for module exports are:

* 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

Here is a recommended way to get setup:
1. Fork this project
2. Clone your new fork, `git clone git@github.com:GithubUser/mapbox-gl-js.git`
3. `cd mapbox-gl-js`
4. Add the Mapbox repository as an upstream repository: `git add remote upstream git@github.com:mapbox/mapbox-gl-js.git`
5. Create a new branch `git checkout -b your-branch` for your contribution
6. Write code, open a PR from your branch when you're ready
7. When you need to rebase your fork's PR branch onto master: `git fetch upstream`, `git rebase upstream/master` and force push to Github `git push --force origin your-branch`
Meekohi marked this conversation as resolved.
Show resolved Hide resolved

## Documentation Conventions

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/).
Expand Down