diff options
| author |  Vijay Pai <vpai@google.com> | 2018-01-10 11:12:43 -0800 |
|---|---|---|
| committer |  GitHub <noreply@github.com> | 2018-01-10 11:12:43 -0800 |
| commit | babd579449ab72fb0c21f15290ffc4832829db7d (patch) | |
| tree | 32f5c3810d132bb87c347ddbf0be02eb3f8b85b5 /CONTRIBUTING.md | |
| parent | 2eb22fd67d73a210c1f41d79efcfe52285ccb2ec (diff) | |
Mention requirements for regenerating projects
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af46246822..fc02f16f3b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -44,7 +44,7 @@ How to get your contributions merged smoothly and quickly. - Keep your PR up to date with upstream/master (if there are merge conflicts, we can't really merge your change). -- if you are regenerating the projects using `tools/buildgen/generate_projects.sh`, make changes to generated files a separate commit with commit message `regenerate projects`. Mixing changes to generated and hand-written files make your PR difficult to review. +- if you are regenerating the projects using `tools/buildgen/generate_projects.sh`, make changes to generated files a separate commit with commit message `regenerate projects`. Mixing changes to generated and hand-written files make your PR difficult to review. Note that running this script requires the installation of Python packages `pyyaml` and `mako` (typically installed using `pip`) as well as a recent version of [`go`](https://golang.org/doc/install#install). - **All tests need to be passing** before your change can be merged. We recommend you **run tests locally** before creating your PR to catch breakages early on (see [tools/run_tests](tools/run_tests). Ultimately, the green signal will be provided by our testing infrastructure. The reviewer will help you if there are test failures that seem not related to the change you are making. |