CONTRIBUTING.md

Contributing

All pull requests should be based off the develop branch.

The Calabash iOS Toolchain uses git-flow.

See these links for information about git-flow and git best practices.

Git Flow Step-by-Step guide

• https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow

Git Best Practices

• http://justinhileman.info/article/changing-history/

git-flow command line tool

We don't use the git-flow tools, but this is useful anyway.

• http://danielkummer.github.io/git-flow-cheatsheet/

Start a Feature

Start your work on a feature branch based off develop.

# If you don't already have the develop branch
$ git fetch origin
$ git co -t origin/develop

# If you already have the develop branch
$ git co develop
$ git pull origin develop
$ git co -b feature/my-new-feature

# Publish your branch and make a pull-request on `develop`
$ git push -u origin feature/my-new-feature

Testing

$ scripts/test/run
$ scripts/ci/travis/local-run-as-travis.rb

Releasing

Create the release branch

$ git co develop
$ git pull
$ git checkout -b release/< next version>

No more features can be added. All in-progress features and un-merged pull-requests must wait for the next release.

You can, and should, make changes to the documentation. You can bump the server version.

Create a pull request for the release branch

Do this very soon after you make the release branch to notify the team that you are planning a release.

$ git push -u origin release/< next version >

Again, no more features can be added to this pull request. Only changes to documentation are allowed. You can bump the server version.

Cut a new release

# Make sure all pull requests have been merged to `develop`
# Check CI!
# * https://travis-ci.org/calabash/calabash-ios-server
# * https://travis-ci.org/calabash/calabash-ios
# * http://ci.endoftheworl.de:8080/ # Briar jobs.

# Get the latest develop.

$ git fetch
$ git co develop
$ git pull origin develop

# Get the latest master. If all is well, there should be no changes in master!

$ git fetch
$ git co master
$ git pull origin master

# Get the latest release.

$ git fetch
$ git co -t origin/release/< next version >

# Merge release into master, run the tests and push.
$ git co master
$ git merge release/< next version >
$ script/test/run
$ git push

# Merge release into develop, run the tests and push.
$ git co develop
$ git merge release/< next version >
$ script/text/run
$ git push


# Delete the release branch
$ git push origin :release/< next version >
$ git br -d release/< next version >

# All is well!
You are done!