OLD | NEW |
(Empty) | |
| 1 # How to contribute |
| 2 |
| 3 We definitely welcome patches and contribution to grpc! Here is some guideline |
| 4 and information about how to do so. |
| 5 |
| 6 ## Getting started |
| 7 |
| 8 ### Legal requirements |
| 9 |
| 10 In order to protect both you and ourselves, you will need to sign the |
| 11 [Contributor License Agreement](https://cla.developers.google.com/clas). |
| 12 |
| 13 ### Technical requirements |
| 14 |
| 15 You will need several tools to work with this repository. In addition to all of |
| 16 the packages described in the [INSTALL](INSTALL.md) file, you will also need |
| 17 python, and the mako template renderer. To install the latter, using pip, one |
| 18 should simply be able to do `pip install mako`. |
| 19 |
| 20 In order to run all of the tests we provide, you will need valgrind and clang. |
| 21 More specifically, under debian, you will need the package libc++-dev to |
| 22 properly run all the tests. |
| 23 |
| 24 Compiling and running grpc C++ tests depend on protobuf 3.0.0, gtest and gflags. |
| 25 Although gflags is provided in third_party, you will need to manually install |
| 26 that dependency on your system to run these tests. Under a Debian or Ubuntu |
| 27 system, you can install the gtests and gflags packages using apt-get: |
| 28 |
| 29 ```sh |
| 30 $ [sudo] apt-get install libgflags-dev libgtest-dev |
| 31 ``` |
| 32 |
| 33 If you are planning to work on any of the languages other than C and C++, you |
| 34 will also need their appropriate development environments. |
| 35 |
| 36 If you want to work under Windows, we recommend the use of Visual Studio 2013. |
| 37 The [Community or Express editions](http://www.visualstudio.com/en-us/downloads/
download-visual-studio-vs.aspx) |
| 38 are free and suitable for developing with grpc. Note however that our test |
| 39 environment and tools are available for Unix environments only at the moment. |
| 40 |
| 41 ## Testing your changes |
| 42 |
| 43 We provide a tool to help run the suite of tests in various environments. |
| 44 In order to run most of the available tests, one would need to run: |
| 45 |
| 46 `./tools/run_tests/run_tests.py` |
| 47 |
| 48 If you want to run tests for any of the languages {c, c++, csharp, node, objc, p
hp, python, ruby}, do this: |
| 49 |
| 50 `./tools/run_tests/run_tests.py -l <lang>` |
| 51 |
| 52 To know about the list of available commands, do this: |
| 53 |
| 54 `./tools/run_tests/run_tests.py -h` |
| 55 |
| 56 ## Adding or removing source code |
| 57 |
| 58 Each language uses its own build system to work. Currently, the root's Makefile |
| 59 and the Visual Studio project files are building only the C and C++ source code. |
| 60 In order to ease the maintenance of these files, we have a |
| 61 template system. Please do not contribute manual changes to any of the generated |
| 62 files. Instead, modify the template files, or the build.json file, and |
| 63 re-generate the project files using the following command: |
| 64 |
| 65 `./tools/buildgen/generate_projects.sh` |
| 66 |
| 67 You'll find more information about this in the [templates](templates) folder. |
OLD | NEW |