Add the Chinese and English "Contribute Code" documentations. #220
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cs2be
reviewed
Jan 27, 2018
docs/contribute_code_en.md
Outdated
| pre-commit install | ||
| ``` | ||
|
|
||
| Our pre-commit configuration requires [clang-format 3.8](http://releases.llvm.org/download.html) for auto-formating C/C++ code and yapf for Python. |
There was a problem hiding this comment.
For some linux builds, they can also get it via "apt install clang-format-3.8" or "apt-get install clang-format-3.8"
There was a problem hiding this comment.
Also we use both yapf for auto format, and flake8 for python style checking (yapf does not do a good job of stripping unused imports and other PEP8 requirements).
docs/contribute_code_en.md
Outdated
|
|
||
| 1. Commit | ||
|
|
||
| Before issuing your first `git commit` command, please install [`pre-commit`](http://pre-commit.com/) by running the following commands: |
There was a problem hiding this comment.
They should install "pip install -r requirements.txt" first
docs/contribute_code_en.md
Outdated
| ``` | ||
|
|
||
| Our pre-commit configuration requires [clang-format 3.8](http://releases.llvm.org/download.html) for auto-formating C/C++ code and yapf for Python. | ||
| Please download it and put it to ```/usr/local/bin``` |
There was a problem hiding this comment.
"Please make sure clang-format version 3.8 is available in your path"
cs2be
approved these changes
Jan 29, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
covers how to contribute in
#83