summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-17 20:27:08 (GMT)
committerEvan Shelhamer <shelhamer@imaginarynumber.net>2014-02-17 20:27:08 (GMT)
commit59cdf127c28df07369ca8d2d1ba6f87d21c75972 (patch)
treef855b9c99428e43babfc063c1fd7e4b6985405d5 /README.md
parentd339d242b43ec5bec9dceb657ee0d665d524b1eb (diff)
downloadcaffe-59cdf127c28df07369ca8d2d1ba6f87d21c75972.zip
caffe-59cdf127c28df07369ca8d2d1ba6f87d21c75972.tar.gz
caffe-59cdf127c28df07369ca8d2d1ba6f87d21c75972.tar.bz2
add contributing guide
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 3e0b2a4..08a9fb8 100644
--- a/README.md
+++ b/README.md
@@ -47,3 +47,23 @@ Please kindly cite Caffe in your publications if it helps your research:
Year = {2013},
Howpublished = {\url{http://caffe.berkeleyvision.org/}
}
+
+## Contributing
+
+Caffe is developed with the community by the [Berkeley Vision and Learning
+Center](http://bvlc.eecs.berkeley.edu/). We welcome contributions!
+
+To join in, please note this policy:
+
+- Do your work in [feature
+ branches](https://www.atlassian.com/git/workflows#!workflow-feature-branch).
+- 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 like too.
+- [Pull request](https://help.github.com/articles/using-pull-requests) your
+ contribution to BVLC/caffe's `dev` branch for discussion and review.
+- `dev` is for new development, community contributions, and testing.
+- `master` is handled by BVLC, which will integrate changes from `dev`.
+
+Expect a more detailed contributing guide soon. Thank you.