[Ryu-devel] [PATCH 1/4] README: Dependencies for installing optional requirements

[IWASE Yusuke]

Signed-off-by: IWASE Yusuke <***@gmail.com>
---
README.rst | 10 ++++++++++
1 file changed, 10 insertions(+)

diff --git a/README.rst b/README.rst
index 6034217..1a54ae7 100644
--- a/README.rst
+++ b/README.rst
@@ -47,6 +47,16 @@ If you want to use the functionalities, please install requirements::
Please refer to tools/optional-requires for details.


+Prerequisites
+=============
+If you got some error messages at installation step, please confirm
+dependencies for building required Python packages.
+
+On Ubuntu(16.04 LTS or later)::
+
+ % apt install gcc python-dev libffi-dev libssl-dev libxml2-dev libxslt1-dev zlib1g-dev
+
+
Support
=======
Ryu Official site is `<http://osrg.github.io/ryu/>`_.

[IWASE Yusuke]

Signed-off-by: IWASE Yusuke <***@gmail.com>
---
CONTRIBUTING.rst | 18 +++++++++++++-----
1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index e301f1f..2fc9493 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -5,12 +5,20 @@ How to Get Your Change Into Ryu
Submitting a change
===================

-Send patches to ryu-***@lists.sourceforge.net. Please don't use 'pull
-request' on github. We expect you to send a patch in Linux kernel
-development style. If you are not familiar with it, please read the
-following document:
+Send patches to ryu-***@lists.sourceforge.net. Please don't use "Pull
+Request" on GitHub. We expect you to send patches in "git-format-patch"
+style.

-https://www.kernel.org/doc/Documentation/SubmittingPatches
+.. code-block:: bash
+
+ # "N" means the number of commits to be included
+ $ git format-patch -s HEAD~N
+
+ # To add cover (e.g., [PATCH 0/X]), specify "--cover-letter" option
+ $ git format-patch -s --cover-letter HEAD~N
+
+ # You can send patches by "git send-email" command
+ $ git send-email --to="ryu-***@lists.sourceforge.net" *.patch

Please check your changes with pep8 and run unittests to make sure
that they don't break the existing features. The following command

[IWASE Yusuke]

Signed-off-by: IWASE Yusuke <***@gmail.com>
---
CONTRIBUTING.rst | 10 ++++++++--
1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 2fc9493..93e1890 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -22,9 +22,15 @@ style.

Please check your changes with pep8 and run unittests to make sure
that they don't break the existing features. The following command
-does both for you:
+does both for you.

-***@rose:~/git/ryu$ ./run_tests.sh
+.. code-block:: bash
+
+ # Install dependencies of tests
+ $ pip install -r tools/test-requires
+
+ # Execute unit tests and pep8
+ $ ./run_tests.sh

Of course, you are encouraged to add unittests when you add new
features (it's not a must though).

[IWASE Yusuke]

Signed-off-by: IWASE Yusuke <***@gmail.com>
---
CONTRIBUTING.rst | 33 ++++++++++++++++++++-------------
1 file changed, 20 insertions(+), 13 deletions(-)

diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 93e1890..8e4945d 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -37,28 +37,34 @@ features (it's not a must though).

Python version and libraries
============================
-* Python 2.6+
- As RHEL 6 adopted python 2.6, features only for 2.7+ should be avoided.
+* Python 2.7, 3.4, 3.5:

-* standard library + widely used library
- Basically widely used == OpenStack adopted
- As usual there are exceptions. gevents. Or python binding library for other
+ Ryu supports multiple Python version. CI tests on Travis-CI is running
+ on these versions.
+
+* standard library + widely used library:
+
+ Basically widely used == OpenStack adopted.
+ As usual there are exceptions. Or python binding library for other
component.

Coding style guide
==================
-* pep8
+* pep8:
+
As python is used, PEP8 is would be hopefully mandatory for
- http://www.python.org/dev/peps/pep-0008/
+ https://www.python.org/dev/peps/pep-0008/
+
+* pylint:

-* pylint
Although pylint is useful for finding bugs, but pylint score not very
important for now because we're still at early development stage.
+ https://www.pylint.org/

-* Google python style guide is very helpful
- http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
+* Google python style guide is very helpful:
+ http://google.github.io/styleguide/pyguide.html

- Guidelines derived from Guido's Recommendations
+* Guidelines derived from Guido's Recommendations:

============================= ================= ========
Type Public Internal
@@ -76,10 +82,11 @@ Coding style guide
Local Variables lower_with_under
============================= ================= ========

-* OpenStack Nova style guide
+* OpenStack Nova style guide:
https://github.com/openstack/nova/blob/master/HACKING.rst

-* JSON files
+* JSON files:
+
Ryu source tree has JSON files under ryu/tests/unit/ofproto/json.
They are used by unit tests. To make patches easier to read,
they are normalized using tools/normalize_json.py. Please re-run

[FUJITA Tomonori]

On Tue, 13 Jun 2017 16:24:29 +0900

These patches provide the required APT packages for installing "optional
requirements" and update the procedures for contributing.
README: Dependencies for installing optional requirements
CONTRIBUTING: Update procedure for submitting patches
CONTRIBUTING: Update procedure for running tests
CONTRIBUTING: Update info of Python ver/lib and links
CONTRIBUTING.rst | 61 +++++++++++++++++++++++++++++++++++++-------------------
README.rst | 10 ++++++++++
2 files changed, 51 insertions(+), 20 deletions(-)

Pushed, thanks!