Page History

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

1. Downloading ONOS
2. Development Environment Setup
   
   • IDE Setup
   • Git/Gerrit Setup
   • Java and Maven
   • Building API Docs
3. Test Environment Setup
   • Overview
   • Test Environment Components
   • Test Cells
   • Test VM Setup
4. Issue tracking with JIRA
   
   • Finding issues and tasks
   • Bug reports and feature requests 
   Infrastructure overview
   • Jira, Jenkins, SonarQube, Gerrit
5. 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
   • Licensing and CLA
   • Guidelines
   • Code Review
   • Sample Gerrit Workflow
6. Contributing to ONOS Documentation
   
   • Procedure
   • Conventions Used
7. Further resources
   • Latest test results
   • Events for developers

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

...