From 302aadd4d7a2fbd07356bee9457da934b497c7c4 Mon Sep 17 00:00:00 2001 From: Lucas Wojciechowski Date: Wed, 20 Jul 2016 14:13:12 -0700 Subject: [PATCH] Update CONTRIBUTING.md instructions --- CONTRIBUTING.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 67a5c5d5b19..1790b20296d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,17 +8,19 @@ Hi, and thanks in advance for contributing to Mapbox GL. Here's how we work. Ple ## Git Conventions -If you have commit access to the repository, please be aware that we strive to maintain a clean, mostly-linear history. When merging a branch, please do the following: +If you have commit access to the repository, please be aware that we strive to maintain a clean, mostly-linear history. -* Rebase the branch onto the current tip of the target branch (`master` or `mb-pages`). -* Squash commits until they are self-contained, potentially down to a single commit if appropriate. -* Perform a fast-forward merge into the target branch and push the result. +You may use the GitHub merge button to squash and merge a branch. If you do not want to squash the branch into a single commit, see "Manually Merging a Branch" below. -In particular **do not** use the "Merge pull request" button on GitHub. +Never merge a branch that is failing CI. -This applies when merging pull-requests from external contributors as well. If necessary, rebase and clean up the commits yourself before manually merging them. Then comment in the PR thanking the contributor and noting the final commit hash(es), and close it. +### Manually Merging a Branch -Never merge a branch that is failing CI. +Before manually merging a branch, please + + - rebase the branch onto the current tip of the target branch (`master` or `mb-pages`). + - squash commits until they are self-contained, potentially down to a single commit if appropriate. + - perform a fast-forward merge into the target branch and push the result ## Preparing your Development Environment