Want to contribute? Great! First, read this page.
Contributions to this project must be accompanied by a Contributor License Agreement. You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project. Head over to https://cla.developers.google.com/ to see your current agreements on file or to sign a new one.
You generally only need to submit a CLA once, so if you‘ve already submitted one (even if it was for a different project), you probably don’t need to do it again.
All code should conform to the Go style guidelines.
As a secure runtime, we need to maintain the safety of all of code included in gVisor. The following rules help mitigate issues.
Definitions for the rules below:
No cgo in
runsc. The final binary must be a statically-linked pure Go binary.
Any files importing “unsafe” must have a name ending in
core may only depend on the following packages:
runsc may only depend on the following packages:
All changes must be submitted via Gerrit.
All submissions, including submissions by project members, require review.
To submit a patch, first clone the canonical repository.
git clone https://gvisor.googlesource.com/gvisor
From within the cloned directory, install the commit hooks (optional, but if you don't you will need to generate Change-Ids manually in your commits).
curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit-review.googlesource.com/tools/hooks/commit-msg chmod +x `git rev-parse --git-dir`/hooks/commit-msg
Edit the source and generate commits as you normally would. While making changes, remember to organize commits logically. Changes are not reviewed per branch (as with a pull request), they are reviewed per commit.
Before posting a new patch, you will need to generate an appropriate authentication cookie. Visit the repository and click the “Generate Password” link at the top of the page for instructions.
To post a patch for review, push to a special “for” reference.
git push origin HEAD:refs/for/master
A change link will be generated for the commit, and a team member will review your change request, provide feedback (and submit when appropriate).
If you receive an error like
No Contributor Agreement on file for user ..., make sure you've signed the CLA.
To address feedback, you may need to amend your commit and repush (don't change the Commit-Id in the commit message). This will generate a new version of the change.
When approved, the change will be submitted by a team member and automatically merged into the repository.
Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.