Skip to content

Latest commit

 

History

History
94 lines (65 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

94 lines (65 loc) · 2.98 KB
Raw

How to Contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Make sure you can build the book, and that mdbook serve works. Please follow the instructions in the README.

Testing

We test the course material in several ways:

  • mdbook test: This will test the code samples. Some code sampes are marked with ignore in the Markdown file because the Playground is missing some of the crates we use. For this we have
  • cargo test: This will build and test the Rust code found in our tooling, as well as the code samples which cannot be tested using the Playground.
  • npm test: This will test the functionality of the rendered web pages. See the testing README for details.

Formatting

Please ensure that your files are formatted consistently. We use a few tools for this:

  • dprint for driving the formatting.
  • rustfmt for formatting Rust code.
  • yapf for formatting Python code.
  • msgcat for formatting PO files.

Run dprint fmt to automatically format all files.

Linux

Install dprint using their installation instructions and install rustfmt via rustup.

On Debian, you can install the other tools using:

sudo apt install yapf3 gettext

MacOS

On MacOS with Homebrew, you can install the necessary tools with:

brew install dprint yapf gettext

Windows

On Windows, you can should install Gettext tools for Windows.

Install dprint using their installation instructions and install rustfmt via rustup.

TODO: fill in how to install yapf on Windows.

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.

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult GitHub Help for more information on using pull requests.

Community Guidelines

This project follows Google's Open Source Community Guidelines.