summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTom Hughes <tomhughes@google.com>2023-01-24 18:12:28 (GMT)
committerCopybara-Service <copybara-worker@google.com>2023-01-24 18:13:03 (GMT)
commit408471e20cfaa7ccd585fe5e1c6e7b6fba8ce06e (patch)
tree79bc631468eb9d9d4c2e647f42bc4bea3c2c984b /CONTRIBUTING.md
parent544c96ed5b0fb97ef867c38fbe204df2eaa02d2b (diff)
downloadgoogletest-408471e20cfaa7ccd585fe5e1c6e7b6fba8ce06e.zip
googletest-408471e20cfaa7ccd585fe5e1c6e7b6fba8ce06e.tar.gz
googletest-408471e20cfaa7ccd585fe5e1c6e7b6fba8ce06e.tar.bz2
Fix formatting of Markdown files
PiperOrigin-RevId: 504308485 Change-Id: Ia4ae97b2173b44b89aa5d987ddefd6e0c1488386
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md26
1 files changed, 18 insertions, 8 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 423b067..8bed14b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -102,30 +102,40 @@ To make sure your changes work as intended and don't break existing
functionality, you'll want to compile and run Google Test and GoogleMock's own
tests. For that you can use CMake:
- mkdir mybuild
- cd mybuild
- cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR}
+```
+mkdir mybuild
+cd mybuild
+cmake -Dgtest_build_tests=ON -Dgmock_build_tests=ON ${GTEST_REPO_DIR}
+```
To choose between building only Google Test or Google Mock, you may modify your
cmake command to be one of each
- cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests
- cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests
+```
+cmake -Dgtest_build_tests=ON ${GTEST_DIR} # sets up Google Test tests
+cmake -Dgmock_build_tests=ON ${GMOCK_DIR} # sets up Google Mock tests
+```
Make sure you have Python installed, as some of Google Test's tests are written
in Python. If the cmake command complains about not being able to find Python
(`Could NOT find PythonInterp (missing: PYTHON_EXECUTABLE)`), try telling it
explicitly where your Python executable can be found:
- cmake -DPYTHON_EXECUTABLE=path/to/python ...
+```
+cmake -DPYTHON_EXECUTABLE=path/to/python ...
+```
Next, you can build Google Test and / or Google Mock and all desired tests. On
\*nix, this is usually done by
- make
+```
+make
+```
To run the tests, do
- make test
+```
+make test
+```
All tests should pass.