summaryrefslogtreecommitdiffhomepage
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorIWASE Yusuke <iwase.yusuke0@gmail.com>2017-12-15 10:50:16 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2017-12-17 19:27:46 +0900
commit83650576e4280bff7dac7083b7e842704852093b (patch)
treeb5272ca5ea1e6b5bbe5e5fb7782d0e63147a7a7e /CONTRIBUTING.rst
parentd64db265b38b253fbaf0f3342893830489d074c3 (diff)
travis: Introduce autopep8 test
This patch add a new test using "autopep8" to keep codes reformatted easily by using Python tool. Signed-off-by: IWASE Yusuke <iwase.yusuke0@gmail.com> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst13
1 files changed, 9 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index c98c79be..11387509 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -20,19 +20,24 @@ style.
# You can send patches by "git send-email" command
$ git send-email --to="ryu-devel@lists.sourceforge.net" *.patch
-Please check your changes with pycodestyle(pep8) and run unittests to make sure
-that they don't break the existing features. The following command
-does both for you.
+Please check your changes with autopep8, pycodestyle(pep8) and running
+unit tests to make sure that they don't break the existing features.
+The following command does all for you.
.. code-block:: bash
# Install dependencies of tests
$ pip install -r tools/test-requires
+ # Execute autopep8
+ # Also, it is convenient to add settings of your editor or IDE for
+ # applying autopep8 automatically.
+ $ autopep8 --recursive --in-place ryu/
+
# Execute unit tests and pycodestyle(pep8)
$ ./run_tests.sh
-Of course, you are encouraged to add unittests when you add new
+Of course, you are encouraged to add unit tests when you add new
features (it's not a must though).
Python version and libraries