Contributing to Flocker
ClusterHQ develops software using a variation of the Ultimate Quality Development System.
Each unit of work is defined in an issue in the issue tracker and developed on a branch.
Code is written using test-driven development.
The issue is closed by merging the branch (via a GitHub pull request).
Before a branch is merged it must pass code review.
- The code reviewer ensures that the pull request:
- Follows the coding standard (Python’s PEP 8).
- Includes appropriate documentation.
- Has full test coverage (unit tests and functional tests).
- The tests pass in the continuous integration system (Buildbot).
- Resolves the issue.
The code reviewer can approve the pull request for merging as is, with some changes, or request changes and an additional review.
Talk to Us
Have questions or need help?
Besides filing a GitHub issue with feature requests or bug reports you can also join us on the #clusterhq channel on the irc.freenode.net IRC network or on the flocker-users Google Group.
To run the complete test suite you will need ZFS, geard and Docker installed.
geard requires an operating system with systemd.
The recommended way to get an environment with these installed is to use the included Vagrantfile which will create a pre-configured Fedora 20 virtual machine.
Vagrant 1.6.2 or later is required.
Once you have Vagrant installed (see the Vagrant documentation) you can run the following to get going:
$ vagrant up
$ vagrant ssh
You will need Python 2.7 and a recent version of PyPy installed on your development machine.
If you don’t already have tox on your development machine, you can install it and other development dependencies (ideally in a virtualenv) by doing:
$ python setup.py install .[doc,dev]
You can run all unit tests by doing:
Functional tests require ZFS, geard and Docker to be installed and in the case of the latter two running as well.
In addition, tox needs to be run as root:
Since these tests involve global state on your machine (filesystems, iptables, Docker containers, etc.) we recommend running them in the development Vagrant image.
Documentation is generated using Sphinx and stored in the docs/ directory.
You can build it individually by running:
You can view the result by opening docs/_build/html/index.html in your browser.
Requirements for Contributions
All code must have unit test coverage and to the extent possible functional test coverage.
Use the coverage.py tool with the --branch option to generate line and branch coverage reports.
This report can tell you if you missed anything.
It does not necessarily catch everything though.
Treat it as a helper but not the definitive indicator of success.
You can also see coverage output in the Buildbot details link of your pull request.
Practice test-driven development to ensure all code has test coverage.
All code must have documentation.
Modules, functions, classes, and methods must be documented (even if they are private).
Function parameters and object attributes must be documented (even if they are private).
All user-facing tools must have documentation.
Document tool usage as part of big-picture documentation.
Identify useful goals the user may want to accomplish and document tools within the context of accomplishing those goals.
Documentation should be as accessible and inclusive as possible.
Avoid language and markup which assumes the ability to precisely use a mouse and keyboard, or that the reader has perfect vision.
Create alternative but equal documentation for the visually impaired, for example, by using alternative text on all images.
If in doubt, particularly about markup changes, use http://achecker.ca/ and fix any “Known Problems” and “Likely Problems”.
Add your name (in alphabetical order) to the AUTHORS.rst file.
Project Development Process
The core development team uses GitHub issues to track planned work.
Issues are organized by release milestones, and then by subcategories:
- Issues we don’t expect to do in the release.
These issues don’t have any particular category label.
All issues start in the backlog when they are filed.
The requirements for an issue must be completely specified before it can move out of the backlog.
- Issues that we expect to work on soon.
This is indicated by a design label.
A general plan for accomplishing the requirements must be specified on the issue before it can move to the Ready state.
The issue is assigned to the developer working on the plan.
When there is a proposed plan the review label is added to the issue (so that it has both design and review).
- Issues that are ready to be worked on.
This is indicated by a ready label.
Issues can only be Ready after they have been in Design so they include an implementation plan.
When someone starts work on an issue it is moved to the In Progress category
(the ready keyword is removed and the in progress label is added).
- In Progress
- Such issues are assigned to the developer who is currently working on them.
This is indicated by an in progress label.
When the code is ready for review a new pull request is opened.
The pull request is added to the Review category.
- Ready for Review
- An issue or pull request that includes work that is ready to be reviewed.
This is indicated by a review label.
Issues can either be in design review (design and review) or final review (just review).
A reviewer can move a design review issue to Ready (to indicate the design is acceptable) or back to Design (to indicate it needs more work).
A reviewer can move a final review issue to Approved (to indicate the work is acceptable) or back to In Progress (to indicate more work is needed).
- Passed Review
- A pull request that has some minor problems that need addressing, and can be merged once those are dealt with and all tests pass.
This is indicated by an accepted label.
- Closed issues and pull requests.
- Issues that can’t be worked on because they are waiting on some other work to be completed.
This is indicated by a blocked label.
You can see the current status of all issues and pull requests by visiting https://waffle.io/clusterhq/flocker.
In general issues will move from Backlog to Design to Ready to In Progress.
An in-progress issue will have a branch with the issue number in its name.
When the branch is ready for review a pull request will be created in the Review category.
When the branch is merged the corresponding pull requests and issues will be closed.
Steps to Contribute Code
GitHub collaborators can participate in the development workflow by changing the labels on an issue.
GitHub lets non-collaborators create new issues and pull requests but it does not let them change labels.
If you are not a collaborator you may seek out assistance from a collaborator to set issue labels to reflect the issue’s stage.
- Pick the next issue in the Ready category.
Drag it to the In Progress column in Waffle (or change the label from ready to in progress in GitHub).
- Create a branch from master with a name including a few descriptive words and ending with the issue number, e.g. add-thingie-123.
- Resolve the issue by making changes in the branch.
- Submit the issue/branch for review.
Create a pull request on GitHub for the branch.
The pull request should include a Fixes #123 line referring to the issue that it resolves (to automatically close the issue when the branch is merged).
Make sure Buildbot indicates all tests pass.
- Address any points raised by the reviewer.
If a re-submission for review has been requested, change the label from in progress to review in GitHub (or drag it to the Ready for Review column in Waffle) and go back to step 4.
- Once it is approved, merge the branch into master by clicking the Merge button.
- As a small thank you for contributing to Flocker, we’d like to send you some ClusterHQ swag.
Once your pull request has been merged, just send an email to email@example.com with your t-shirt size, mailing address and a phone number to be used only for filling out the shipping form.
We’ll get something in the mail to you.
Steps to Contribute Reviews
- Pick a pull request in GitHub/Waffle that is ready for review (review label/Review category).
- Use the continuous integration information in the PR to verify the test suite is passing.
- Verify the code satisfies the Requirements for Contribution (see above).
- Verify the change satisfies the requirements specified on the issue.
- Think hard about whether the code is good or bad.
- Leave comments on the GitHub PR page about any of these areas where you find problems.
- Leave a comment on the GitHub PR page explicitly approving or rejecting the change.
If you accept the PR and no final changes are required then use the GitHub merge button to merge the branch.
If you accept the PR but changes are needed move it to the Review Passed column in Waffle or change its label from review to approved.
If you do not accept the PR move it to the In Progress column in Waffle or change its label from review to in progress.