Skip to content

Latest commit

 

History

History
48 lines (36 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

48 lines (36 loc) · 2.24 KB
Raw

Contributing to Bazel

Contributor License Agreement

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.

Contribution process

  1. Explain your idea and discuss your plan with members of the team. The best way to do this is to create an issue or comment on an existing issue.
  2. Prepare a git commit with your change. Don't forget to add tests. Run the existing tests with bazel test //.... Update README.md if appropriate.
  3. Create a pull request. This will start the code review process. All submissions, including submissions by project members, require review.
  4. You may be asked to make some changes. You'll also need to sign the CLA at this point, if you haven't done so already. Our continuous integration bots will test your change automatically on supported platforms. Once everything looks good, your change will be merged.

Setting up your development environment

Read how to set up your development environment

Bazel Remote Cache

The remote cache configuration for this repository is stored in .bazelrc.remote-cache and grouped under the name, remote-cache. It is configured to allow read-only access for all clients and read-write for CI.

To enable the remote cache,

  1. Add build --remote_header=x-buildbuddy-api-key=${buildbuddy_api_key} to .bazelrc.auth at the root of the workspace, replacing ${buildbuddy_api_key} with the actual API key value.
  2. Add build --config=remote-cache to .bazelrc.local at the root of the workspace.