diff options
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c85027117a..c2dc4eba57 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,8 +73,11 @@ How to get your contributions merged smoothly and quickly. - 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 + 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 |