diff options
| author | Azul <azul@riseup.net> | 2016-07-04 22:02:05 +0200 |
|---|---|---|
| committer | Azul <azul@riseup.net> | 2016-07-05 08:56:05 +0200 |
| commit | 78d1b0daae8b7d667c8cb5a8da0b1efba029801f (patch) | |
| tree | d45a0ea7e660d8751e64d517b52f0fe05362d837 | |
| parent | 6b08e8c89d26225786736ad69ba335b275a1a048 (diff) | |
[doc] make sure to mention develop branch in dev docs
| -rw-r--r-- | README.md | 12 | ||||
| -rw-r--r-- | doc/DEVELOP.md | 14 |
2 files changed, 25 insertions, 1 deletions
@@ -68,14 +68,24 @@ tools. We host our own git repository. In order to create a local clone run git clone --recursive git://leap.se/leap_web + cd leap_web The repo is mirrored on github and we accept pull requests there: https://github.com/leapcode/leap_web +### Pick branch (development only) + +We use the master branch for the stable version deployed to production. +Development usually happens on the develop branch. So for development you +want to run + + git checkout origin/develop -b develop + +This will create a local branch called develop based on our develop branch. + ### Install required ruby libraries - cd leap_web bundle --binstubs Typically, you run ``bundle`` as a normal user and it will ask you for a diff --git a/doc/DEVELOP.md b/doc/DEVELOP.md index e0c07d6..97ecd25 100644 --- a/doc/DEVELOP.md +++ b/doc/DEVELOP.md @@ -1,5 +1,19 @@ # Development # +## Branches + +We use the 'master' branch to hold the version currently deployed to the +production servers. Only hotfixes are applied here. + +Most of development happens based upon the 'develop' branch. So unless +you are investigating a specific issue that occured in production you +probably want to base your changes on 'develop': +``` +git checkout origin/develop -b my-new-feature +``` +This will create a new branch called 'my-new-feature' based on the develop +branch from the origin remote. + ## Setting up the local CouchDB CouchDB operates in Admin Party by default, meaning there are no access |