Thank you for your time and effort to help us improve Rook! Here are a few steps to get started. If you have any questions, don't hesitate to reach out to us on our Slack dev channel.
- GO 1.19 or greater installed
- Git client installed
- GitHub account
Create a Fork¶
From your browser navigate to http://github.com/rook/rook and click the "Fork" button.
Clone Your Fork¶
Open a console window and do the following;
Add Upstream Remote¶
First you will need to add the upstream remote to your local git:
Now you should have at least
upstream remotes. You can also add other remotes to collaborate with other contributors.
Before building the project you have to fetch the upstream to synchronize tags.
If you want to use
podman instead of
docker then uninstall
docker packages from your machine, make will automatically pick up
If you are in linux environment and
make build command throws an error like
unknown revision for some imports, try adding
export GOPROXY=https://proxy.golang.org,direct to
~/.bashrc and then run
source ~/.bashrc or to a similar file to update your environment and confirm with
go env that
GOPROXY is updated.
To provide consistent whitespace and other formatting in your
go and other source files (e.g., Markdown), it is recommended you apply the following settings in your IDE:
- Format with the
- Trim trailing whitespace
- Markdown Table of Contents is correctly updated automatically
VS Code should prompt you automatically with some recommended extensions to install. E.g., Markdown All in One, Go and YAML validator.
A set of recommended settings when working on Rook, can be found here.
VS Code should automatically use these settings through the
Self assign Issue¶
You can self-assign any issue that is open and not assigned to anyone in Rook upstream repo, by adding an issue comment with
/assign in the body.
A source code layout is shown below, annotated with comments about the use of each important directory:
To add a feature or to make a bug fix, you will need to create a branch in your fork and then submit a pull request (PR) from the branch.
For new features of significant scope and complexity, a design document is recommended before work begins on the implementation. So create a design document if:
- Adding a new CRD
- Adding a significant feature to an existing storage provider. If the design is simple enough to describe in a github issue, you likely don't need a full design doc.
For smaller, straightforward features and bug fixes, there is no need for a design document. Authoring a design document for big features has many advantages:
- Helps flesh out the approach by forcing the author to think critically about the feature and can identify potential issues early on
- Gets agreement amongst the community before code is written that could be wasted effort in the wrong direction
- Serves as an artifact of the architecture that is easier to read for visitors to the project than just the code by itself
Writing code to prototype the feature while working on the design may be very useful to help flesh out the approach.
A design document should be written as a markdown file in the design folder. You can follow the process outlined in the design template. You will see many examples of previous design documents in that folder. Submit a pull request for the design to be discussed and approved by the community before being merged into master, just like any other change to the repository.
An issue should be opened to track the work of authoring and completing the design document. This issue is in addition to the issue that is tracking the implementation of the feature. The design label should be assigned to the issue to denote it as such.
Create a Branch¶
From a console, create a new branch based on your fork and start working on it:
Now you are ready to make the changes and commit to your branch.
Updating Your Fork¶
During the development lifecycle, you will need to keep up-to-date with the latest upstream master. As others on the team push changes, you will need to
rebase your commits on top of the latest. This avoids unnecessary merge commits and keeps the commit history clean.
Whenever you need to update your local repository, you never want to merge. You always will rebase. Otherwise you will end up with merge commits in the git history. If you have any modified files, you will first have to stash them (
git stash save -u "<some description>").
Rebasing is a very powerful feature of Git. You need to understand how it works or else you will risk losing your work. Read about it in the Git documentation, it will be well worth it. In a nutshell, rebasing does the following:
- "Unwinds" your local commits. Your local commits are removed temporarily from the history.
- The latest changes from upstream are added to the history
- Your local commits are re-applied one by one
- If there are merge conflicts, you will be prompted to fix them before continuing. Read the output closely. It will tell you how to complete the rebase.
- When done rebasing, you will see all of your commits in the history.
Submitting a Pull Request¶
Once you have implemented the feature or bug fix in your branch, you will open a Pull Request (PR) to the upstream Rook repository. Before opening the PR ensure you have added unit tests and all unit tests are passing. Please clean your commit history and rebase on the latest upstream changes.
See Unit Tests below for instructions on how to run unit tests.
In order to open a pull request (PR) it is required to be up to date with the latest changes upstream. If other commits are pushed upstream before your PR is merged, you will also need to rebase again before it will be merged.
All pull requests must pass the unit and integration tests before they can be merged. These tests automatically run against every pull request as a part of Rook's continuous integration (CI) process. The results of these tests along with code reviews and other criteria determine whether your request will be accepted into the
From the root of your local Rook repo execute the following to run all of the unit tests:
Unit tests for individual packages can be run with the standard
go test command. Before you open a PR, confirm that you have sufficient code coverage on the packages that you changed. View the
coverage.html in a browser to inspect your new code.
Writing unit tests¶
There is no one-size-fits-all approach to unit testing, but we attempt to provide good tips for writing unit tests for Rook below.
Unit tests should help people reading and reviewing the code understand the intended behavior of the code.
Good unit tests start with easily testable code. Small chunks ("units") of code can be easily tested for every possible input. Higher-level code units that are built from smaller, already-tested units can more easily verify that the units are combined together correctly.
Common cases that may need tests:
- the feature is enabled
- the feature is disabled
- the feature is only partially enabled, for every possible way it can be partially enabled
- every error that can be encountered during execution of the feature
- the feature can be disabled (including partially) after it was enabled
- the feature can be modified (including partially) after it was enabled
- if there is a slice/array involved, test length = 0, length = 1, length = 3, length == max, length > max
- an input is not specified, for each input
- an input is specified incorrectly, for each input
- a resource the code relies on doesn't exist, for each dependency
Running the Integration Tests¶
Rook's upstream continuous integration (CI) tests will run integration tests against your changes automatically.
You do not need to run these tests locally, but you may if you like. For instructions on how to do so, follow the test instructions.
Rook maintainers value clear, lengthy and explanatory commit messages. So by default each of your commits must:
- be prefixed by the component it's affecting, if Ceph, then the title of the commit message should be
ceph: my commit title. If not the commit-lint bot will complain.
- contain a commit message which explains the original issue and how it was fixed if a bug. If a feature it is a full description of the new functionality.
- refer to the issue it's closing, this is mandatory when fixing a bug
- have a sign-off, this is achieved by adding
-swhen committing so in practice run
git commit -s. If not the DCO bot will complain. If you forgot to add the sign-off you can also amend a previous commit with the sign-off by running
git commit --amend -s. If you've pushed your changes to GitHub already you'll need to force push your branch with
git push -f.
Here is an example of an acceptable commit message:
component MUST be in the list checked by the CI.
Sometimes you will feel like there is not so much to say, for instance if you are fixing a typo in a text.
In that case, it is acceptable to shorten the commit message. Also, you don't always need to close an issue, again for a very small fix.
You can read more about conventional commits.
To prepare your branch to open a PR, you will need to have the minimal number of logical commits so we can maintain a clean commit history. Most commonly a PR will include a single commit where all changes are squashed, although sometimes there will be multiple logical commits.
Once your commit history is clean, ensure you have based on the latest upstream before you open the PR.
Go to the Rook github to open the PR. If you have pushed recently, you should see an obvious link to open the PR. If you have not pushed recently, go to the Pull Request tab and select your fork and branch for the PR.
After the PR is open, you can make changes simply by pushing new commits. Your PR will track the changes in your fork and update automatically.
Never open a pull request against a released branch (e.g. release-1.2) unless the content you are editing is gone from master and only exists in the released branch. By default, you should always open a pull request against master.
Backport a Fix to a Release Branch¶
The flow for getting a fix into a release branch is:
- Open a PR to merge the changes to master following the process outlined above.
- Add the backport label to that PR such as backport-release-1.7
- After your PR is merged to master, the mergify bot will automatically open a PR with your commits backported to the release branch
- If there are any conflicts you will need to resolve them by pulling the branch, resolving the conflicts and force push back the branch
- After the CI is green, the bot will automatically merge the backport PR.