From 1eb80cc46d1d375e36907992dc713c2d05ac5f7f Mon Sep 17 00:00:00 2001 From: Dan Finlay Date: Wed, 25 Apr 2018 11:05:47 -0700 Subject: [PATCH] Add develop guide to contributing.md Explain our new master-develop git branch strategy, so developers know which branch to PR against. --- CONTRIBUTING.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5d2e5207b..8517eed70 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,12 +12,14 @@ For any new programmatic functionality, we like unit tests when possible, so if ### PR Format -We use [waffle](https://waffle.io/) for project management, and it will automatically keep us organized if you do one simple thing: - If this PR closes the issue, add the line `Fixes #$ISSUE_NUMBER`. Ex. For closing issue 418, include the line `Fixes #418`. If it doesn't close the issue but addresses it partially, just include a reference to the issue number, like `#418`. +Submit your PR against the `develop` branch. This is where we merge new features so they get some time to receive extra testing before being pushed to `master` for production. + +If your PR is a hot-fix that needs to be published urgently, you may submit a PR against the `master` branch, but this PR will receive tighter scrutiny before merging. + ## Before Merging Make sure you get a `:thumbsup`, `:+1`, or `LGTM` from another collaborator before merging.