Skip to content

Latest commit

 

History

History
102 lines (78 loc) · 3.49 KB

CONTRIBUTING.rst

File metadata and controls

102 lines (78 loc) · 3.49 KB

How to Get Your Change Into Ryu

Submitting a change

To send patches to ryu, please make a pull request on GitHub.

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.

# 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 unit tests when you add new features (it's not a must though).

Python version and libraries

  • Python 3.5, 3.6, 3.7, 3.8, 3.9:

    Ryu supports multiple Python versions. CI tests on GitHub Actions 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

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