summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-27 09:05:13 (GMT)
committerEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-27 09:05:13 (GMT)
commiteba58e45d9d04a4e23a5ac14807a323af5ce7d8c (patch)
tree1405d43ec565201f9d6704253835368774517638 /README.md
parent812bc018571ab084184ed9819eca5832d5e15e74 (diff)
downloadcaffe-eba58e45d9d04a4e23a5ac14807a323af5ce7d8c.zip
caffe-eba58e45d9d04a4e23a5ac14807a323af5ce7d8c.tar.gz
caffe-eba58e45d9d04a4e23a5ac14807a323af5ce7d8c.tar.bz2
outline pull request etiquette
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index 3894a86..59762ca 100644
--- a/README.md
+++ b/README.md
@@ -69,6 +69,10 @@ Our workflow is this:
- Do new development in [feature branches](https://www.atlassian.com/git/workflows#!workflow-feature-branch) with decriptive names.
- Bring your work up-to-date by [rebasing](http://git-scm.com/book/en/Git-Branching-Rebasing) onto the latest `dev`. (Polish your changes by [interactive rebase](https://help.github.com/articles/interactive-rebase), if you'd like.)
- [Pull request](https://help.github.com/articles/using-pull-requests) your contribution to BVLC/caffe's `dev` branch for discussion and review.
+ * PRs should live fast, die young, and leave a beautiful merge. Pull
+ request sooner than later so that discussion can guide development.
+ * Code must be accompanied by documentation and tests at all times.
+ * Only fast-forward merges will be accepted.
#### [Shelhamer's](https://github.com/shelhamer) "life of a branch in four acts":
@@ -87,15 +91,15 @@ git checkout dev
git pull upstream dev
# rebase your branch on the tip of dev
git checkout feature
-git rebase --preserve-merges dev
+git rebase dev
```
Push your branch to pull request it into `dev`
```
git push origin feature
-# ...make pull request...
+# ...make pull request to dev...
```
-Now make a pull request! You can do this from the command line (`git pull-request`) if you install [hub](https://github.com/github/hub).
+Now make a pull request! You can do this from the command line (`git pull-request -b dev`) if you install [hub](https://github.com/github/hub).
-The pull request of feature into `dev` will be a clean merge, applause.
+The pull request of `feature` into `dev` will be a clean merge. Applause.