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.
Some editors may require the code to be structured in a
GOPATH directory tree.
In this case, you may use the
:gopath target to generate a directory tree with
symlinks to the original source files.
bazel build :gopath
You can then set the
GOPATH in your editor to
If you use this mechanism, keep in mind that the generated tree is not the
canonical source. You will still need to build and test with
bazel. New files
will need to be added to the appropriate
BUILD files, and the
will need to be re-run to generate appropriate symlinks in the
Dependencies can be added by using
go mod get. In order to keep the
WORKSPACE file in sync, run
tools/go_mod.sh in place of
All Go code should conform to the Go style guidelines. C++ code should conform to the Google C++ Style Guide and the guidelines described for tests. Note that code may be automatically formatted per the guidelines when merged.
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:
Before sending code reviews, run
bazel test ... to ensure tests are passing.
Code changes are accepted via pull request.
When approved, the change will be submitted by a team member and automatically merged into the repository.
Accessing check logs may require membership in the gvisor-dev mailing list, which is public.
Some TODOs and NOTEs sprinkled throughout the code have associated IDs of the
b/1234. These correspond to bugs in our internal bug tracker. Eventually
these bugs will be moved to the GitHub Issues, but until then they can simply be
make dev is a convenient way to build and install
runsc as a Docker
runtime. The output of this command will show the runtimes installed.
You may use
make refresh to refresh the binary after any changes. For example:
make dev docker run --rm --runtime=my-branch --rm hello-world make refresh
Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.