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 Environment Setup
   
   • IDE Setup
   • Git/Gerrit Setup
   • Java and Maven
   • Building API Docs
2. Sample Application Development
3. Web GUI Content Development
4. Test Environment Setup
   • Overview
   • Test Environment Components
   • Test Cells
   • Test VM Setup
5. Continuous Integration
6. Issue Tracking and Submission with JIRA
   
   • Finding, Claiming, and Working On Issues
   • Creating Issues : bugs, feature requests, documentation
7. Contributing to the ONOS Codebase
   • Getting ONOS source code
   • Licensing and Contributor Agreement
   • Guidelines
   • Code Review
   • Sample Gerrit Workflow
8. Contributing to ONOS Documentation
   
   • Procedure
   • Conventions Used

Appendix A : List of ONOS Utility Scripts (onos-* scripts)
Appendix B : REST API
Appendix C : Source Tree Organization
Appendix D : Troubleshooting Multi-module Projects
Appendix E: Incubator Tree

Appendix F : Web GUI Framework Libraries

Next : Development Environment Setup

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.