diff options
author | Carlos O'Ryan <coryan@google.com> | 2017-12-11 19:33:27 -0500 |
---|---|---|
committer | Carlos O'Ryan <coryan@google.com> | 2017-12-11 19:33:27 -0500 |
commit | 23a014ab578682ae11c3e68c77a1cde3b77f7a90 (patch) | |
tree | 4be276a49a00388a46ecbff0f52161af509aceb8 /README.md | |
parent | c82cd5e41e3755fc9ed65912ca3acaae69921dbb (diff) | |
download | googletest-23a014ab578682ae11c3e68c77a1cde3b77f7a90.tar.gz googletest-23a014ab578682ae11c3e68c77a1cde3b77f7a90.tar.bz2 googletest-23a014ab578682ae11c3e68c77a1cde3b77f7a90.zip |
Refactor docs about contributions to CONTRIBUTING.md.
Per the review comments.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 32 |
1 files changed, 3 insertions, 29 deletions
@@ -114,35 +114,9 @@ package (as described below): * Mac OS X v10.4 Tiger or newer * Xcode Developer Tools -### Requirements for Contributors ### +## Contributing change -We welcome patches. If you plan to contribute a patch, you need to -build Google Test and its own tests from a git checkout (described -below), which has further requirements: - - * [Python](https://www.python.org/) v2.3 or newer (for running some of - the tests and re-generating certain source files from templates) - * [CMake](https://cmake.org/) v2.6.4 or newer - -## Regenerating Source Files ## - -Some of Google Test's source files are generated from templates (not -in the C++ sense) using a script. -For example, the -file include/gtest/internal/gtest-type-util.h.pump is used to generate -gtest-type-util.h in the same directory. - -You don't need to worry about regenerating the source files -unless you need to modify them. You would then modify the -corresponding `.pump` files and run the '[pump.py](googletest/scripts/pump.py)' -generator script. See the [Pump Manual](googletest/docs/PumpManual.md). - -### Contributing Code ### - -We welcome patches. Please read the -[Developer's Guide](googletest/docs/DevGuide.md) -for how you can contribute. In particular, make sure you have signed -the Contributor License Agreement, or we won't be able to accept the -patch. +Please read the [`CONTRIBUTING.md`](CONTRIBUTING.md) for details on +how to contribute to this project. Happy testing! |