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
   • Development Environment Setup
     
     • IDE Setup
     • Git/Gerrit Setup
     • Java and Maven
     • Building API Docs
   • Test Environment Setup
     • Overview
     • Test Environment Components
     • Test Cells
     • Test VM Setup
2. Contributing to ONOS
   • Infrastructure overview
     • Jira, Jenkins, SonarQube, Gerrit
   • Contributing to the ONOS Codebase
     
     • Submitting patches

• • • Writing unit tests and Javadocs
    • Don’t break things: Sanity checking with Maven
    • Promotion (Is this accurate, and do we want this here?)
  • Sample Workflow
    
  • Contributing to ONOS Documentation
    
    • Procedure
    • Conventions Used

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