Fetching contributors…
Cannot retrieve contributors at this time
70 lines (49 sloc) 3.39 KB

Contributing to Girder Worker

There are many ways to contribute to Girder Worker, with varying levels of effort. Do try to look through the documentation first if something is unclear, and let us know how we can do better.

We encourage a range of Pull Requests, from patches that include passing tests and documentation, all the way down to half-baked ideas that launch discussions.

The PR Process, Travis CI, and Related Gotchas

How to submit a PR ?

If you are new to Girder Worker development and you don't have push access to the Girder Worker repository, here are the steps:

  1. Fork and clone the repository.
  2. Create a branch.
  3. Push the branch to your GitHub fork.
  4. Create a Pull Request.

This corresponds to the Fork & Pull Model mentioned in the GitHub flow guides.

If you have push access to Girder Worker repository, you could simply push your branch into the main repository and create a Pull Request. This corresponds to the Shared Repository Model and will facilitate other developers to checkout your topic without having to configure a remote. It will also simplify the workflow when you are co-developing a branch.

When submitting a PR, make sure to add a Cc: @girder_worker/developers comment to notify Girder Worker developers of your awesome contributions. Based on the comments posted by the reviewers, you may have to revisit your patches.

How to integrate a PR ?

Getting your contributions integrated is relatively straightforward, here is the checklist:

  • All tests pass
  • Consensus is reached. This usually means that at least one reviewer added a LGTM comment and a reasonable amount of time passed without anyone objecting. LGTM is an acronym for Looks Good to Me.

Next, there are two scenarios:

  • You do NOT have push access: A Girder Worker core developer will integrate your PR.
  • You have push access: Simply click on the "Merge pull request" button.

Then, click on the "Delete branch" button that appears afterward.

Automatic testing of pull requests

When you submit a PR to the Girder Worker repo, Travis CI will run the full build on two different branches

  • The commit at the head of the PR branch, the push build
  • The head of the PR branch that is then merged into master, the pr branch

The Travis build will run according to the .travis.yml file, which is useful as an example for how to set up your own environment for testing.

The tests that run in Travis are harnessed with CTest, which submits the results of its automated testing to Girder Worker's CDash dashboard where the test and coverage results can be easily visualized and explored.