From a6aab3bd9535b8abee909b492307b921f6e16e9f Mon Sep 17 00:00:00 2001 From: Pauline Sho Date: Wed, 6 Apr 2022 10:57:06 -0700 Subject: [PATCH] Minor update to `CONTRIBUTING.md` on cpplint installation. (#1023) * Minor update to `CONTRIBUTING.md` on cpplint installation. `cpplint` can be installed via `pip` as well as getting a local copy. Improving documentation to include the `pip` alternative. * Minor update to `CONTRIBUTING.md` on cpplint installation. `cpplint` can be installed via `pip` as well as getting a local copy. Improving documentation to include the `pip` alternative. BUG= * Change pip3 to pip Co-authored-by: Ting Yan <94130036+tingyan19@users.noreply.github.com> --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a18ce1b0..4b2a86f7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,12 +166,17 @@ Below are some tips that might be useful and improve the development experience. is the what we do for the TFLM continuous integration Docker container. * Get a copy of [cpplint](https://github.com/google/styleguide/tree/gh-pages/cpplint) + or install it: + + ``` + pip install cpplint + ``` * [yapf](https://github.com/google/yapf/) should be used for formatting Python code. For example: ``` - pip3 install yapf + pip install yapf yapf log_parser.py -i --style='{based_on_style: pep8, indent_width: 2}' ``` @@ -193,7 +198,7 @@ Below are some tips that might be useful and improve the development experience. 1. Make sure your code is lint-free. ``` - cpplint.py `git ls-files -m` + cpplint `git ls-files -m` ``` 1. Run all the tests for x86, and any other platform that you are modifying. -- GitLab