diff options
| author |  Abhishek Kumar <abhikumar@google.com> | 2015-02-25 11:04:44 -0800 |
|---|---|---|
| committer | Abhishek Kumar <abhikumar@google.com> | 2015-02-25 11:04:44 -0800 |
| commit | 9e81817ee587478035536634c95d011372397d6f (patch) | |
| tree | 0b885f27569156cc5426279baddc3a6aca638aad /CONTRIBUTING.md | |
| parent | c753c19b79518399fb6fb7ffdeb0e82e50751789 (diff) | |
Update CONTRIBUTING.md
Massage wording and fix the instructions for run_tests to remove reference to non-existsant -l all option.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57d176f663..b58c3568fc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,27 +24,27 @@ properly run all the tests. If you are planning to work on any of the languages other than C and C++, you will also need their appropriate development environments. -If you want to work under Windows, we recommend you to use Visual Studio 2013. +If you want to work under Windows, we recommend the use of Visual Studio 2013. The [Community or Express editions](http://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx) are free and suitable for developing with grpc. Note however that our test environment and tools are available for Unix environments only at the moment. ## Testing your changes -We provide a tool to help you run our suite of tests in various environments. +We provide a tool to help run the suite of tests in various environments. In order to run most of the available tests, one would need to run: `./tools/run_tests/run_tests.py` -If you want to run all the possible tests for all possible languages, do this: +If you want to run all the possible tests for any of the languages {c, c++, node, php, python}, do this: -`./tools/run_tests/run_tests.py -lall -call` +`./tools/run_tests/run_tests.py -l <lang> -c all` ## Adding or removing source code Each language uses its own build system to work. Currently, the root's Makefile -and the Visual Studio project files are building the C and C++ source code only -at the moment. In order to ease the maintenance of these files, we have a +and the Visual Studio project files are building only the C and C++ source code. +In order to ease the maintenance of these files, we have a template system. Please do not contribute manual changes to any of the generated files. Instead, modify the template files, or the build.json file, and re-generate the project files using the following command: |