All pull requests should be based off the develop branch.
This project uses gitflow.
See these links for information about git-flow and git best practices.
Please see this post for tips on how to make a good commit message.
We don't use the git-flow tools, but this is useful anyway.
Start your work on a feature branch based off develop.
# If you don't already have the develop branch
$ git fetch origin
$ git checkout -t origin/develop
# If you already have the develop branch
$ git checkout develop
$ git pull origin develop
$ git checkout -b feature/my-new-feature
# Publish your branch and make a pull-request on `develop`
$ git push -u origin feature/my-new-feature
After the release branch is created:
- 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 gem version.
The release pull request must be made against the master branch.
$ git co develop
$ git co -b release/1.5.0
1. Update the CHANGELOG.
2. Bump the version in the ./version file
3. Have a look at the README.md to see if it can be updated.
$ git push -u origin release/1.5.0
**IMPORTANT**
1. Make a pull request on GitHub on the master branch.
2. Wait for CI to finish.
3. Merge pull request.
$ git co master
$ git pull
$ git checkout develop
$ git merge --no-ff release/1.5.0
$ git push
$ git branch -d release/1.5.0
$ git checkout master
$ bin/git-tag.sh
Announce the release on the public channels.