Page History

Welcome to the ONOS Developer 's Guide! Here you will find information useful for developing on ONOS, contributing to ONOS itselfthe ONOS core components and drivers as well as ONOS applications, and the tools and procedures involved in the overall ONOS development process. This guide also describes how to contribute to the ONOS Guides; to do so, please refer to Contributing to ONOS Documentation.

1. Development tools
   • Infrastructure overview
     • Jira, Jenkins, SonarQube, Gerrit
   • Development Environment Setup
     • IDE Setup
     • Test Environment Setup
     • Git/Gerrit Setup
     • Java and Maven
   • ONOS dev tools and test scripts (onos-*, tvue)
   • test frameworks/cbench?
2. Building the ONOS API docs
3. Contributing to ONOS

• • 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

...

Guides

The Developer Quick Start should be enough to get you started with ONOS core development. If you like more detailed instructions for importing the ONOS project into an IDE or contributing your changes back to the ONOS project, please see the resources below.