Contributing

Workflow

The master branch stores official ESTER's releases. Every release is tagged in the master branch.

The dev branch is the branch to use to push commits between releases.

Modifying the Code

If you want to contribute, please feel free to clone the repository and either send patches by email to ester-dev@irap.omp.eu or submit pull requests with github.

Remember that you should fork off of the dev branch to ease merging your features into the next release.

Releasing

As said earlier, new releases should go to the master branch. When the dev branch is mature enough to be released:

1. Freeze the current version by creating a branch called release-x.y.z where x.y.z is the release number (e.g., 1.1.0).
2. Checkout this branch and edit VERSION to set greek to rc1.
3. Checkout dev and update VERSION to the next version by increasing one of the major, minor or release number.
4. Once release-x.y.z is ready to be released:
   1. edit VERSION and set greek the empty string
   2. merge it into the master branch
   3. tag the current HEAD with the corresponding version (e.g., v1.1.1)
   4. you also should merge release-x.y.z into dev to integrate changes made in this branch, but be careful not to change VERSION in dev
5. Eventually you can update the source archives at: http://ester-project.github.io/ester/ with tarballs made from the latest release.