Have questions? Stuck? Please check our FAQ for some common questions and answers.

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

This section describes the various aspects involved in code contribution to the ONOS project.

Licensing and Contributor Agreement

Any code contributed to ONOS source must be released under the Apache 2.0 license, i.e. the licensing information must appear in the header of contributed files. The IDE setup section describes how to configure the IDE to automatically add the licensing information for two IDEs, Eclipse and IntelliJ.

In addition, code submitters must agree to the project Contributor License Agreement (CLA), based on that of the Apache Software Foundation. The CLA may be found here.

Guidelines

To maintain a level of manageability in the codebase, the project maintains a set of coding and testing guidelines.

Coding style

The code style guide can be found here. Many IDEs may be configured to take care of the formatting aspects of the coding style. 

Unit tests

Any new classes or system components should be accompanied by unit (JUnit) tests. For existing code, any changes that do not alter functionality should pass existing tests; however, existing tests should also be modified to reflect any changes that alter the behavior of a class or interface. 

All available unit tests are run as part of a full build process. Contributions should pass all tests and build successfully before being submitted. 

Code Review

The ONOS project uses Gerrit for code review. Once submitted, a changeset is inspected by core ONOS developers. Who reviews the submitted changeset depends on several criteria. For example, the reviewers for a changeset involving the existing codebase will likely include current maintainers of the particular subsystems that the changeset affects.

Feedback

The primary mode for feedback is via email.

For a changeset to be accepted, it must receive one review with a +2 (not to be confused with two reviews of +1). A changeset given a -2 will not be accepted. 

Code submission

The process of submitting code and amending changesets is described in the Sample Workflow.

  • No labels