summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorYann Collet <yann.collet.73@gmail.com>2014-08-08 11:48:45 (GMT)
committerYann Collet <yann.collet.73@gmail.com>2014-08-08 11:48:45 (GMT)
commit0be64b41c9da191638f24c9a3437c5b4ee22a2a6 (patch)
treeef76016a87e050ec76bc9839e3f1f2cdeb879104 /README.md
parent5ba9d1d520672086b9aae68d72309e07bb8c276e (diff)
downloadlz4-0be64b41c9da191638f24c9a3437c5b4ee22a2a6.zip
lz4-0be64b41c9da191638f24c9a3437c5b4ee22a2a6.tar.gz
lz4-0be64b41c9da191638f24c9a3437c5b4ee22a2a6.tar.bz2
clarified "dev" branch policy
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/README.md b/README.md
index 463ae4f..7ab64cc 100644
--- a/README.md
+++ b/README.md
@@ -10,9 +10,11 @@ A high compression derivative, called LZ4_HC, is also provided. It trades CPU ti
|dev | [![Build Status](https://travis-ci.org/Cyan4973/lz4.svg?branch=dev)](https://travis-ci.org/Cyan4973/lz4) |
This is an official mirror of LZ4 project, [hosted on Google Code](http://code.google.com/p/lz4/).
-The intention is to offer github's capabilities to lz4 users, such as cloning, branch, or source download.
+The intention is to offer github's capabilities to lz4 users, such as cloning, branch, pull requests or source download.
-The "master" branch will reflect, the status of lz4 at its official homepage. Other branches will also exist, typically to fix some open issues or new requirements, and be available for testing before merge into master.
+The "master" branch will reflect, the status of lz4 at its official homepage.
+The "dev" branch is the one where all contributions will be merged. If you plan to propose a patch, please commit into the "dev" branch. Direct commit to "master" are not permitted.
+Feature branches will also exist, typically to introduce new requirements, and be temporarily available for testing before merge into "dev" branch.
Benchmarks