113481Sgiacomo.travaglini@arm.com 213481Sgiacomo.travaglini@arm.com 313481Sgiacomo.travaglini@arm.comIf you are interested in understanding the internals of Google Test, 413481Sgiacomo.travaglini@arm.combuilding from source, or contributing ideas or modifications to the 513481Sgiacomo.travaglini@arm.comproject, then this document is for you. 613481Sgiacomo.travaglini@arm.com 713481Sgiacomo.travaglini@arm.com# Introduction # 813481Sgiacomo.travaglini@arm.com 913481Sgiacomo.travaglini@arm.comFirst, let's give you some background of the project. 1013481Sgiacomo.travaglini@arm.com 1113481Sgiacomo.travaglini@arm.com## Licensing ## 1213481Sgiacomo.travaglini@arm.com 1313481Sgiacomo.travaglini@arm.comAll Google Test source and pre-built packages are provided under the [New BSD License](http://www.opensource.org/licenses/bsd-license.php). 1413481Sgiacomo.travaglini@arm.com 1513481Sgiacomo.travaglini@arm.com## The Google Test Community ## 1613481Sgiacomo.travaglini@arm.com 1713481Sgiacomo.travaglini@arm.comThe Google Test community exists primarily through the [discussion group](http://groups.google.com/group/googletestframework) and the GitHub repository. 1813481Sgiacomo.travaglini@arm.comYou are definitely encouraged to contribute to the 1913481Sgiacomo.travaglini@arm.comdiscussion and you can also help us to keep the effectiveness of the 2013481Sgiacomo.travaglini@arm.comgroup high by following and promoting the guidelines listed here. 2113481Sgiacomo.travaglini@arm.com 2213481Sgiacomo.travaglini@arm.com### Please Be Friendly ### 2313481Sgiacomo.travaglini@arm.com 2413481Sgiacomo.travaglini@arm.comShowing courtesy and respect to others is a vital part of the Google 2513481Sgiacomo.travaglini@arm.comculture, and we strongly encourage everyone participating in Google 2613481Sgiacomo.travaglini@arm.comTest development to join us in accepting nothing less. Of course, 2713481Sgiacomo.travaglini@arm.combeing courteous is not the same as failing to constructively disagree 2813481Sgiacomo.travaglini@arm.comwith each other, but it does mean that we should be respectful of each 2913481Sgiacomo.travaglini@arm.comother when enumerating the 42 technical reasons that a particular 3013481Sgiacomo.travaglini@arm.comproposal may not be the best choice. There's never a reason to be 3113481Sgiacomo.travaglini@arm.comantagonistic or dismissive toward anyone who is sincerely trying to 3213481Sgiacomo.travaglini@arm.comcontribute to a discussion. 3313481Sgiacomo.travaglini@arm.com 3413481Sgiacomo.travaglini@arm.comSure, C++ testing is serious business and all that, but it's also 3513481Sgiacomo.travaglini@arm.coma lot of fun. Let's keep it that way. Let's strive to be one of the 3613481Sgiacomo.travaglini@arm.comfriendliest communities in all of open source. 3713481Sgiacomo.travaglini@arm.com 3813481Sgiacomo.travaglini@arm.comAs always, discuss Google Test in the official GoogleTest discussion group. 3913481Sgiacomo.travaglini@arm.comYou don't have to actually submit code in order to sign up. Your participation 4013481Sgiacomo.travaglini@arm.comitself is a valuable contribution. 4113481Sgiacomo.travaglini@arm.com 4213481Sgiacomo.travaglini@arm.com# Working with the Code # 4313481Sgiacomo.travaglini@arm.com 4413481Sgiacomo.travaglini@arm.comIf you want to get your hands dirty with the code inside Google Test, 4513481Sgiacomo.travaglini@arm.comthis is the section for you. 4613481Sgiacomo.travaglini@arm.com 4713481Sgiacomo.travaglini@arm.com## Compiling from Source ## 4813481Sgiacomo.travaglini@arm.com 4913481Sgiacomo.travaglini@arm.comOnce you check out the code, you can find instructions on how to 5013481Sgiacomo.travaglini@arm.comcompile it in the [README](../README.md) file. 5113481Sgiacomo.travaglini@arm.com 5213481Sgiacomo.travaglini@arm.com## Testing ## 5313481Sgiacomo.travaglini@arm.com 5413481Sgiacomo.travaglini@arm.comA testing framework is of no good if itself is not thoroughly tested. 5513481Sgiacomo.travaglini@arm.comTests should be written for any new code, and changes should be 5613481Sgiacomo.travaglini@arm.comverified to not break existing tests before they are submitted for 5713481Sgiacomo.travaglini@arm.comreview. To perform the tests, follow the instructions in 5813481Sgiacomo.travaglini@arm.com[README](../README.md) and verify that there are no failures. 5913481Sgiacomo.travaglini@arm.com 6013481Sgiacomo.travaglini@arm.com# Contributing Code # 6113481Sgiacomo.travaglini@arm.com 6213481Sgiacomo.travaglini@arm.comWe are excited that Google Test is now open source, and hope to get 6313481Sgiacomo.travaglini@arm.comgreat patches from the community. Before you fire up your favorite IDE 6413481Sgiacomo.travaglini@arm.comand begin hammering away at that new feature, though, please take the 6513481Sgiacomo.travaglini@arm.comtime to read this section and understand the process. While it seems 6613481Sgiacomo.travaglini@arm.comrigorous, we want to keep a high standard of quality in the code 6713481Sgiacomo.travaglini@arm.combase. 6813481Sgiacomo.travaglini@arm.com 6913481Sgiacomo.travaglini@arm.com## Contributor License Agreements ## 7013481Sgiacomo.travaglini@arm.com 7113481Sgiacomo.travaglini@arm.comYou must sign a Contributor License Agreement (CLA) before we can 7213481Sgiacomo.travaglini@arm.comaccept any code. The CLA protects you and us. 7313481Sgiacomo.travaglini@arm.com 7413481Sgiacomo.travaglini@arm.com * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). 7513481Sgiacomo.travaglini@arm.com * If you work for a company that wants to allow you to contribute your work to Google Test, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). 7613481Sgiacomo.travaglini@arm.com 7713481Sgiacomo.travaglini@arm.comFollow either of the two links above to access the appropriate CLA and 7813481Sgiacomo.travaglini@arm.cominstructions for how to sign and return it. 7913481Sgiacomo.travaglini@arm.com 8013481Sgiacomo.travaglini@arm.com## Coding Style ## 8113481Sgiacomo.travaglini@arm.com 8213481Sgiacomo.travaglini@arm.comTo keep the source consistent, readable, diffable and easy to merge, 8313481Sgiacomo.travaglini@arm.comwe use a fairly rigid coding style, as defined by the [google-styleguide](http://code.google.com/p/google-styleguide/) project. All patches will be expected 8413481Sgiacomo.travaglini@arm.comto conform to the style outlined [here](http://google-styleguide.googlecode.com/svn/trunk/cppguide.xml). 8513481Sgiacomo.travaglini@arm.com 8613481Sgiacomo.travaglini@arm.com## Updating Generated Code ## 8713481Sgiacomo.travaglini@arm.com 8813481Sgiacomo.travaglini@arm.comSome of Google Test's source files are generated by the Pump tool (a 8913481Sgiacomo.travaglini@arm.comPython script). If you need to update such files, please modify the 9013481Sgiacomo.travaglini@arm.comsource (`foo.h.pump`) and re-generate the C++ file using Pump. You 9113481Sgiacomo.travaglini@arm.comcan read the PumpManual for details. 9213481Sgiacomo.travaglini@arm.com 9313481Sgiacomo.travaglini@arm.com## Submitting Patches ## 9413481Sgiacomo.travaglini@arm.com 9513481Sgiacomo.travaglini@arm.comPlease do submit code. Here's what you need to do: 9613481Sgiacomo.travaglini@arm.com 9713481Sgiacomo.travaglini@arm.com 1. A submission should be a set of changes that addresses one issue in the [issue tracker](https://github.com/google/googletest/issues). 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 have a corresponding issue in the issue tracker, please create one. 9813481Sgiacomo.travaglini@arm.com 1. 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 early also generally leads to better patches. 9913481Sgiacomo.travaglini@arm.com 1. Ensure that your code adheres to the [Google Test source code style](#Coding_Style.md). 10013481Sgiacomo.travaglini@arm.com 1. Ensure that there are unit tests for your code. 10113481Sgiacomo.travaglini@arm.com 1. Sign a Contributor License Agreement. 10213481Sgiacomo.travaglini@arm.com 1. Create a Pull Request in the usual way. 10313481Sgiacomo.travaglini@arm.com 10413481Sgiacomo.travaglini@arm.com## Google Test Committers ## 10513481Sgiacomo.travaglini@arm.com 10613481Sgiacomo.travaglini@arm.comThe current members of the Google Test engineering team are the only 10713481Sgiacomo.travaglini@arm.comcommitters at present. In the great tradition of eating one's own 10813481Sgiacomo.travaglini@arm.comdogfood, we will be requiring each new Google Test engineering team 10913481Sgiacomo.travaglini@arm.commember to earn the right to become a committer by following the 11013481Sgiacomo.travaglini@arm.comprocedures in this document, writing consistently great code, and 11113481Sgiacomo.travaglini@arm.comdemonstrating repeatedly that he or she truly gets the zen of Google 11213481Sgiacomo.travaglini@arm.comTest. 11313481Sgiacomo.travaglini@arm.com 11413481Sgiacomo.travaglini@arm.com# Release Process # 11513481Sgiacomo.travaglini@arm.com 11613481Sgiacomo.travaglini@arm.comWe follow a typical release process: 11713481Sgiacomo.travaglini@arm.com 11813481Sgiacomo.travaglini@arm.com 1. A release branch named `release-X.Y` is created. 11913481Sgiacomo.travaglini@arm.com 1. Bugs are fixed and features are added in trunk; those individual patches are merged into the release branch until it's stable. 12013481Sgiacomo.travaglini@arm.com 1. An individual point release (the `Z` in `X.Y.Z`) is made by creating a tag from the branch. 12113481Sgiacomo.travaglini@arm.com 1. Repeat steps 2 and 3 throughout one release cycle (as determined by features or time). 12213481Sgiacomo.travaglini@arm.com 1. Go back to step 1 to create another release branch and so on. 12313481Sgiacomo.travaglini@arm.com 12413481Sgiacomo.travaglini@arm.com--- 12513481Sgiacomo.travaglini@arm.com 12613481Sgiacomo.travaglini@arm.comThis page is based on the [Making GWT Better](http://code.google.com/webtoolkit/makinggwtbetter.html) guide from the [Google Web Toolkit](http://code.google.com/webtoolkit/) project. Except as otherwise [noted](http://code.google.com/policies.html#restrictions), the content of this page is licensed under the [Creative Commons Attribution 2.5 License](http://creativecommons.org/licenses/by/2.5/). 127