Before sending your pull requests, make sure you do the following:
We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement (CLA).
Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.
NOTE: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.
This project follows Google's Open Source Community Guidelines.
If you have improvements to Cobalt, send us your pull requests! For those just getting started, Github has a how to.
Cobalt team members will be assigned to review your pull requests. A team member will need to approve the workflow runs for each pull request. Once the pull requests are approved and pass all presubmit checks, a Cobalt team member will merge the pull request.
Before sending your pull request for review, make sure your changes are consistent with the guidelines and follow the Cobalt coding style.
Include a license at the top of new files. Check existing files for license examples.
Cobalt follows the Chromium style guide.
Cobalt uses pre-commit to ensure good coding style. Create a python 3 virtual environment for working with Cobalt, then install
$ pre-commit install -t post-checkout -t pre-commit -t pre-push --allow-missing-config
pre-commit will mostly run automatically, and can also be invoked manually. You can find documentation about it at https://pre-commit.com/.
First, ensure Docker and docker-compose are installed on your system. Then, you can run unit tests for our linux reference implementation using:
$ docker-compose up --build --no-start linux-x64x11-unittest $ PLATFORM=linux-x64x11 CONFIG=devel TARGET=all docker-compose run linux-x64x11 $ PLATFORM=linux-x64x11 CONFIG=devel docker-compose run linux-x64x11-unittest