Skip to content

contributing

David Spreekmeester edited this page Mar 12, 2018 · 5 revisions

Contributing to Garp

For outside enthusiasts, fork it and offer us your pull requests!
We're always happy to merge good ideas.

Workflow for anyone with writing access

(Note: Garp no longer uses the GitFlow model as per 22 May 2017. The develop branch is deprecated.)

Garp3 follows the OneFlow model.

In order to publish new changes to Packagist the workflow would be something like:

  • Make sure master is up to date with origin by pulling it.
  • Make note of the latest tag by doing git tag --sort=v:refname.
  • Start a release branch if you have stuff to finish and want to free up master to your colleagues, but that's optional.
  • When the release branch is done, tag it with git tag <increment-of-previously-noted-tag>
  • Merge the release branch.
  • Delete the release branch.

For example:

# start the release branch
git checkout -b release/v2.3.0

# finish the release branch
git checkout release/v3.3.0
git tag v3.3.0
git checkout master
git merge release/v3.3.0
git push --tags origin master

# delete branch locally
git branch -d release/v3.3.0

If you have pushed the release branch to the remote, use the following to delete it:

git push origin :release/v2.3.0

(note the colon in front of the branch name, which deletes it)

Clone this wiki locally