summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorSteve Purcell <steve@sanityinc.com>2015-01-11 10:09:44 +0000
committerSteve Purcell <steve@sanityinc.com>2015-01-11 11:00:36 +0000
commit0bb32bb8fad2167285ea220cf604225f5ed7d0f5 (patch)
tree3b9d2b65d2e4adda22c2e4bc444a705c15c141fc /CONTRIBUTING.md
parentd4b20926c85a4989a845da21c2c36bbd1e183451 (diff)
downloadfork-ledger-0bb32bb8fad2167285ea220cf604225f5ed7d0f5.tar.gz
fork-ledger-0bb32bb8fad2167285ea220cf604225f5ed7d0f5.tar.bz2
fork-ledger-0bb32bb8fad2167285ea220cf604225f5ed7d0f5.zip
Add CONTRIBUTING.md, mainly to document the "next" vs "master" branching
This file is displayed to would-be pull-request submitters, so it's a good place to provide this information. [ci skip]
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 00000000..a4b8b14f
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,8 @@
+Tips for contributors
+---------------------
+
+* Please **make pull requests against `next`, not `master`**.
+ Ledger follows a [git-flow](http://nvie.com/posts/a-successful-git-branching-model/) branching model,
+ in which development happens on the `next` branch and is subsequently merged into `master` for releases.
+* If you're making **changes to `ledger-mode`, or other files for which the Travis build is not
+ relevant**, please **add `[ci skip]` to the end of the commit message**.