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 bazel-bin/gopath
.
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 :gopath
target
will need to be re-run to generate appropriate symlinks in the GOPATH
directory tree.
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.
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:
core
:
//pkg/sentry/...
- Transitive dependencies in
//pkg/...
,//third_party/...
.
runsc
:
//runsc/...
Rules:
-
No cgo in
core
orrunsc
. The final binary must be a statically-linked pure Go binary. -
Any files importing "unsafe" must have a name ending in
_unsafe.go
. -
core
may only depend on the following packages:- Itself.
- Go standard library.
- Except (transitively) package "net" (this will result in a non-cgo
binary). Use
//pkg/unet
instead.
- Except (transitively) package "net" (this will result in a non-cgo
binary). Use
@org_golang_x_sys//unix:go_default_library
(Go importgolang.org/x/sys/unix
).- Generated Go protobuf packages.
@com_github_golang_protobuf//proto:go_default_library
(Go importgithub.aaakk.us.kg/golang/protobuf/proto
).@com_github_golang_protobuf//ptypes:go_default_library
(Go importgithub.aaakk.us.kg/golang/protobuf/ptypes
).
-
runsc
may only depend on the following packages:- All packages allowed for
core
. @com_github_google_subcommands//:go_default_library
(Go importgithub.aaakk.us.kg/google/subcommands
).@com_github_opencontainers_runtime_spec//specs_go:go_default_library
(Go importgithub.aaakk.us.kg/opencontainers/runtime-spec/specs_go
).
- All packages allowed for
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
form 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
ignored.
scripts/dev.sh
is a convenient script that builds and installs runsc
as a
new Docker runtime for you. The scripts tries to extract the runtime name from
your local environment and will print it at the end. You can also customize it.
The script creates one regular runtime and another with debug flags enabled.
Here are a few examples:
# Default case (inside branch my-branch)
$ scripts/dev.sh
...
Runtimes my-branch and my-branch-d (debug enabled) setup.
Use --runtime=my-branch with your Docker command.
docker run --rm --runtime=my-branch --rm hello-world
If you rebuild, use scripts/dev.sh --refresh.
Logs are in: /tmp/my-branch/logs
# --refresh just updates the runtime binary and doesn't restart docker.
$ git/my_branch> scripts/dev.sh --refresh
# Using a custom runtime name
$ git/my_branch> scripts/dev.sh my-runtime
...
Runtimes my-runtime and my-runtime-d (debug enabled) setup.
Use --runtime=my-runtime with your Docker command.
docker run --rm --runtime=my-runtime --rm hello-world
Contributions made by corporations are covered by a different agreement than the one above, the Software Grant and Corporate Contributor License Agreement.