Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Welcome to the ONOS Developer's Guide! Here you will find information useful for developing on ONOS, contributing to ONOS itself, and the tools and procedures involved in the ONOS development process. This guide also describes how to contribute to the ONOS Guides.

 

  1. Development tools
    • Infrastructure overview
      • JiraJenkinsSonarQubeGerrit
    • Development environment
      • IDE setup
        • Code formatting and coding style
        • Adding licensing information
      • Git 
      • Maven
      • Sample workflow
    • ONOS dev tools and test scripts (onos-*, tvue)
    • test frameworks/cbench?
  2. Building the ONOS API docs
  3. Contributing to ONOSReporting bugs : Creating tickets on Jira
    • Contributing to the ONOS Codebase
      • Submitting patches
      • Writing unit tests and Javadocs
      • Don’t break things: Sanity checking with Maven
      • Mentoring and Promotion (Is this accurate, and do we want this here?)
    • Contributing to

...

    • ONOS

...

    • Documentation

Appendix A : Listing of List of ONOS Test Scripts (onos-* scripts)
Appendix B :   REST API
Appendix C : Source tree organization
Appendix D : Minding namespaces and bundles

...