Developer's Guide

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
     • Jira
     • Jenkins
     • SonarQube
     • Gerrit
   • Development environment
     • IDE setup
       • Code formatting and coding style
       • Adding licensing information
     • Git 
     • Maven
       
   • ONOS dev tools and test scripts (onos-*, tvue)
   • test frameworks/cbench?
2. Building the ONOS API docs
3. Contributing to ONOS
   • Reporting bugs : Creating tickets on Jira
     
   • Submitting patches
   • Writing unit tests and Javadocs
   • Don’t break things: Sanity checking with Maven
4. Contributing to the ONOS Guides

Appendix A : Listing of onos-* scripts
Appendix B : REST API
Appendix C : Source tree organization
Appendix D : Minding namespaces and bundles