Skip to content

Latest commit

 

History

History
88 lines (71 loc) · 3.3 KB

CONTRIBUTING.rst

File metadata and controls

88 lines (71 loc) · 3.3 KB

How to Get Your Change Into Ryu

Submitting a change

Send patches to ryu-devel@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:

https://www.kernel.org/doc/Documentation/SubmittingPatches

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:

fujita@rose:~/git/ryu$ ./run_tests.sh

Of course, you are encouraged to add unittests when you add new 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.
  • standard library + widely used library Basically widely used == OpenStack adopted As usual there are exceptions. gevents. Or python binding library for other component.

Coding style guide

Reference

  • Python Essential Reference, 4th Edition [Amazon] * Paperback: 717 pages * Publisher: Addison-Wesley Professional; 4 edition (July 19, 2009) * Language: English * ISBN-10: 0672329786 * ISBN-13: 978-0672329784
  • The Python Standard Library by Example (Developer's Library) * Paperback: 1344 pages * Publisher: Addison-Wesley Professional; 1 edition (June 11, 2011) * Language: English * ISBN-10: 0321767349 * ISBN-13: 978-0321767349