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.

1. Development Environment Setup
   
   • IDE Setup
   • Git/Gerrit Setup
   • Java and Maven
   • Building API Docs
2. Test Environment Setup
   • Overview
   • Test Environment Components
   • Test Cells
   • Test VM Setup
3. Infrastructure overview
   • Jira, Jenkins, SonarQube, Gerrit
4. 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?)
5. Sample Workflow
6. 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 : Troubleshooting Multi-module Projects

...

; to do so, please refer to 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.