CONTRIBUTING.md (googletest-release-1.10.0) | : | CONTRIBUTING.md (googletest-release-1.11.0) | ||
---|---|---|---|---|
skipping to change at line 31 | skipping to change at line 31 | |||
## Are you a Googler? | ## Are you a Googler? | |||
If you are a Googler, please make an attempt to submit an internal change rather | If you are a Googler, please make an attempt to submit an internal change rather | |||
than a GitHub Pull Request. If you are not able to submit an internal change a | than a GitHub Pull Request. If you are not able to submit an internal change a | |||
PR is acceptable as an alternative. | PR is acceptable as an alternative. | |||
## Contributing A Patch | ## Contributing A Patch | |||
1. Submit an issue describing your proposed change to the | 1. Submit an issue describing your proposed change to the | |||
[issue tracker](https://github.com/google/googletest). | [issue tracker](https://github.com/google/googletest/issues). | |||
2. Please don't mix more than one logical change per submittal, because it | 2. Please don't mix more than one logical change per submittal, because it | |||
makes the history hard to follow. If you want to make a change that doesn't | makes the history hard to follow. If you want to make a change that doesn't | |||
have a corresponding issue in the issue tracker, please create one. | have a corresponding issue in the issue tracker, please create one. | |||
3. Also, coordinate with team members that are listed on the issue in question. | 3. Also, coordinate with team members that are listed on the issue in question. | |||
This ensures that work isn't being duplicated and communicating your plan | This ensures that work isn't being duplicated and communicating your plan | |||
early also generally leads to better patches. | early also generally leads to better patches. | |||
4. If your proposed change is accepted, and you haven't already done so, sign a | 4. If your proposed change is accepted, and you haven't already done so, sign a | |||
Contributor License Agreement (see details above). | Contributor License Agreement (see details above). | |||
5. Fork the desired repo, develop and test your code changes. | 5. Fork the desired repo, develop and test your code changes. | |||
6. Ensure that your code adheres to the existing style in the sample to which | 6. Ensure that your code adheres to the existing style in the sample to which | |||
skipping to change at line 83 | skipping to change at line 83 | |||
itself is a valuable contribution. | itself is a valuable contribution. | |||
## Style | ## Style | |||
To keep the source consistent, readable, diffable and easy to merge, we use a | To keep the source consistent, readable, diffable and easy to merge, we use a | |||
fairly rigid coding style, as defined by the | fairly rigid coding style, as defined by the | |||
[google-styleguide](https://github.com/google/styleguide) project. All patches | [google-styleguide](https://github.com/google/styleguide) project. All patches | |||
will be expected to conform to the style outlined | will be expected to conform to the style outlined | |||
[here](https://google.github.io/styleguide/cppguide.html). Use | [here](https://google.github.io/styleguide/cppguide.html). Use | |||
[.clang-format](https://github.com/google/googletest/blob/master/.clang-format) | [.clang-format](https://github.com/google/googletest/blob/master/.clang-format) | |||
to check your formatting | to check your formatting. | |||
## Requirements for Contributors | ## Requirements for Contributors | |||
If you plan to contribute a patch, you need to build Google Test, Google Mock, | If you plan to contribute a patch, you need to build Google Test, Google Mock, | |||
and their own tests from a git checkout, which has further requirements: | and their own tests from a git checkout, which has further requirements: | |||
* [Python](https://www.python.org/) v2.3 or newer (for running some of the | * [Python](https://www.python.org/) v2.3 or newer (for running some of the | |||
tests and re-generating certain source files from templates) | tests and re-generating certain source files from templates) | |||
* [CMake](https://cmake.org/) v2.6.4 or newer | * [CMake](https://cmake.org/) v2.8.12 or newer | |||
## Developing Google Test and Google Mock | ## Developing Google Test and Google Mock | |||
This section discusses how to make your own changes to the Google Test project. | This section discusses how to make your own changes to the Google Test project. | |||
### Testing Google Test and Google Mock Themselves | ### Testing Google Test and Google Mock Themselves | |||
To make sure your changes work as intended and don't break existing | 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 | functionality, you'll want to compile and run Google Test and GoogleMock's own | |||
tests. For that you can use CMake: | tests. For that you can use CMake: | |||
skipping to change at line 131 | skipping to change at line 131 | |||
Next, you can build Google Test and / or Google Mock and all desired tests. On | Next, you can build Google Test and / or Google Mock and all desired tests. On | |||
\*nix, this is usually done by | \*nix, this is usually done by | |||
make | make | |||
To run the tests, do | To run the tests, do | |||
make test | make test | |||
All tests should pass. | All tests should pass. | |||
### 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/pump_manual.md). | ||||
End of changes. 4 change blocks. | ||||
3 lines changed or deleted | 3 lines changed or added |