This section describes how to submit bug reports and feature requests, and to contribute code and documentation to the project. It also describes the general workflow involved in code contribution.
Reporting bugs
Creating tickets on JIRA : As mentioned earlier, the ONOS project employs JIRA to track the status of various tasks.
Submitting patches
Writing unit tests and Javadocs : Naturally, code contributions almost always include writing unit tests (JUnit) and documenting the codebase (comments and Javadocs).
Don’t break things: Sanity checking with Maven
Promotion : With a good track record, a contributor may advance to core developer status (Do we implement a mentorship system here?).
The ONOS Guides and tutorials are written using the Confluence Wiki markup interface. In order to lower the curve required to add or edit information, and to introduce consistency, the Guides avoid the usage of raw HTML and Wiki Notation as much as possible, relying on formatting and macros provided by the Confluence interface.
A potential contributor should message onos-discuss if they are interested in contributing tutorials and full sections in the guides, or maintaining sections in the documentations.
Several conventions are used within the documents, and any new material should conform to them.
Each section in a page should have a terse title in one of the Heading levels under the Paragraph dropdown. The convention for (sub)section headings are:
To apply a heading format, simply drop the cursor on a line, and select the heading from the dropdown.
Code blocks are used instead of inlined monotype for multi-word/line commands and sample shell/CLI output. Code blocks may be added by:
This brings up the prompt for configuring the code block. Here, syntax highlighting should be turned off by selecting "Plain Text" in the Syntax Highlighting option before hitting "Create".
It is good to link to the appropriate pages/sections whenever they are mentioned.
Whenever a new page is added to a Guide, corresponding links should also be added to the top-level TOC.