-
Notifications
You must be signed in to change notification settings - Fork 0
Contributing back
We'd love you to contribute back to EasyBuild, and here's how you can do it: the branch - hack - pull request cycle.
First, you'll need to fork EasyBuild on GitHub.
If you do not have a (free) GitHub account yet, you'll need to get one.
You should also register an SSH public key, so you can easily clone, push to and pull from your repository.
Clone your fork of the EasyBuild repository to your favorite workstation, and check out the develop branch:
git clone git@github.com:YOUR_GITHUB_LOGIN/easybuild.git
cd easybuild
git branch develop
git pull origin develop
git checkout develop
The develop branch hosts the latest bleeding-edge version of EasyBuild, and is merged into master regularly (after thorough testing). Make sure you update it every time you create a feature branch (see below):
git checkout develop
git pull origin develop
Create a feature branch for your work (pick a somewhat descriptive name), and check it out
git checkout develop
git branch <BRANCH_NAME>
git checkout <BRANCH_NAME>
Make sure to always base your features branches on develop, not on master!
After creating the branch, implement your contributions: new features, new easyblocks for non-supported software, enhancements or updates to existing easyblocks, bug fixes, or rewriting the whole thing in Fortran, whatever you like.
Make sure you commit your work, and try to do it in bite-size chunks, so the commit log remains clear.
For example:
git add easybuild/easyblocks/l/linuxfromscratch.py
git commit -m "support for Linux From Scratch"
If you are working on several things at the same time, try and keep things isolated in seperate branches, to keep it manageable (both for you, and for reviewing your contributions, see below).
When you've finished the implementation of a particular contribution, here's how to get it into the main EasyBuild repository.
Push your branch to your EasyBuild repository on GitHub:
git push origin <BRANCH_NAME>
Issue a pull request for your branch into the main EasyBuild repository, as follows:
-
go to github.com/YOUR_GITHUB_LOGIN/easybuild, and make sure the branch you just pushed is selected (not master, but <BRANCH_NAME>)
-
issue a pull request (see button at the top of the page) for your branch to the develop branch of the main EasyBuild repository; don't issue a pull request to the master branch, as it will be simply closed by the EasyBuild team
A member of the EasyBuild team will then review your pull request, paying attention to what you're contributing, how you implemented it and code style.
Most likely, some remarks will be made on your pull request. Note that this is nothing personal, we're just trying to keep the EasyBuild codebase as high quality as possible. Even when an EasyBuild team member makes changes, the same public review process is followed.
Try and act on the remarks made, either by commiting additional changes to your branch, or by replying to the remarks to clarify your work.
Once your pull request has been reviewed and remarks have been processed, your contribution will be merged into the develop branch of the main EasyBuild repository.
On frequent occasions, the develop branch is merged into the master branch and a new version is tagged, and your contribution truly becomes part of EasyBuild.