CONTRIBUTING.md 5.51 KB
Newer Older
1 2 3 4
# How to become a contributor and submit your own code

## Contributor License Agreements

misterg's avatar
misterg committed
5 6
We'd love to accept your patches! Before we can take them, we have to jump a
couple of legal hurdles.
7 8 9 10

Please fill out either the individual or corporate Contributor License Agreement
(CLA).

misterg's avatar
misterg committed
11
*   If you are an individual writing original source code and you're sure you
12 13
    own the intellectual property, then you'll need to sign an
    [individual CLA](https://developers.google.com/open-source/cla/individual).
misterg's avatar
misterg committed
14
*   If you work for a company that wants to allow you to contribute your work,
15 16 17 18 19 20 21
    then you'll need to sign a
    [corporate CLA](https://developers.google.com/open-source/cla/corporate).

Follow either of the two links above to access the appropriate CLA and
instructions for how to sign and return it. Once we receive it, we'll be able to
accept your pull requests.

Gennadiy Civil's avatar
Gennadiy Civil committed
22 23
## Are you a Googler?

Krystian Kuzniarek's avatar
Krystian Kuzniarek committed
24
If you are a Googler, please make an attempt to submit an internal change rather
misterg's avatar
misterg committed
25 26
than a GitHub Pull Request. If you are not able to submit an internal change a
PR is acceptable as an alternative.
Gennadiy Civil's avatar
Gennadiy Civil committed
27

28 29
## Contributing A Patch

misterg's avatar
misterg committed
30
1.  Submit an issue describing your proposed change to the
31
    [issue tracker](https://github.com/google/googletest/issues).
32
2.  Please don't mix more than one logical change per submittal, because it
misterg's avatar
misterg committed
33 34
    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.
35
3.  Also, coordinate with team members that are listed on the issue in question.
misterg's avatar
misterg committed
36 37
    This ensures that work isn't being duplicated and communicating your plan
    early also generally leads to better patches.
38
4.  If your proposed change is accepted, and you haven't already done so, sign a
misterg's avatar
misterg committed
39
    Contributor License Agreement (see details above).
40 41
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
misterg's avatar
misterg committed
42
    you are contributing.
43 44
7.  Ensure that your code has an appropriate set of unit tests which all pass.
8.  Submit a pull request.
misterg's avatar
misterg committed
45 46

## The Google Test and Google Mock Communities
47 48

The Google Test community exists primarily through the
misterg's avatar
misterg committed
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
[discussion group](http://groups.google.com/group/googletestframework) and the
GitHub repository. Likewise, the Google Mock community exists primarily through
their own [discussion group](http://groups.google.com/group/googlemock). You are
definitely encouraged to contribute to the discussion and you can also help us
to keep the effectiveness of the group high by following and promoting the
guidelines listed here.

### Please Be Friendly

Showing courtesy and respect to others is a vital part of the Google culture,
and we strongly encourage everyone participating in Google Test development to
join us in accepting nothing less. Of course, being courteous is not the same as
failing to constructively disagree with each other, but it does mean that we
should be respectful of each other when enumerating the 42 technical reasons
that a particular proposal may not be the best choice. There's never a reason to
be antagonistic or dismissive toward anyone who is sincerely trying to
65 66
contribute to a discussion.

misterg's avatar
misterg committed
67 68 69
Sure, C++ testing is serious business and all that, but it's also a lot of fun.
Let's keep it that way. Let's strive to be one of the friendliest communities in
all of open source.
70

misterg's avatar
misterg committed
71 72
As always, discuss Google Test in the official GoogleTest discussion group. You
don't have to actually submit code in order to sign up. Your participation
73 74
itself is a valuable contribution.

75 76
## Style

misterg's avatar
misterg committed
77 78 79 80 81 82
To keep the source consistent, readable, diffable and easy to merge, we use a
fairly rigid coding style, as defined by the
[google-styleguide](https://github.com/google/styleguide) project. All patches
will be expected to conform to the style outlined
[here](https://google.github.io/styleguide/cppguide.html). Use
[.clang-format](https://github.com/google/googletest/blob/master/.clang-format)
Abseil Team's avatar
Abseil Team committed
83
to check your formatting.
84

misterg's avatar
misterg committed
85
## Requirements for Contributors
86

misterg's avatar
misterg committed
87 88
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:
89

misterg's avatar
misterg committed
90 91
*   [Python](https://www.python.org/) v2.3 or newer (for running some of the
    tests and re-generating certain source files from templates)
Chuck Atkins's avatar
Chuck Atkins committed
92
*   [CMake](https://cmake.org/) v2.8.12 or newer
93

94
## Developing Google Test and Google Mock
95

96
This section discusses how to make your own changes to the Google Test project.
97

98
### Testing Google Test and Google Mock Themselves
99 100

To make sure your changes work as intended and don't break existing
101 102
functionality, you'll want to compile and run Google Test and GoogleMock's own
tests. For that you can use CMake:
103 104 105

    mkdir mybuild
    cd mybuild
106 107 108 109 110 111 112
    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
113

misterg's avatar
misterg committed
114 115 116 117
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:
118

119 120
    cmake -DPYTHON_EXECUTABLE=path/to/python ...

121 122
Next, you can build Google Test and / or Google Mock and all desired tests. On
\*nix, this is usually done by
123 124

    make
125

126
To run the tests, do
127 128 129 130

    make test

All tests should pass.