User Tools

Site Tools


This is an old revision of the document!

Welcome to the OPNFV developer resources page.

On this page you will eventually find all resources needed to get started working with OPNFV and the tools to make your time enjoyable and hopefully as productive as possible. If there are items missing from this WiKi that you would like to see, either start the process of adding them or start a dialog on the OPNFV mailing lists.

Understanding OPNFV Projects and roles

To understand how we run projects and coordinate our activities in OPNFV look into our Project ABC's page.

Get Setup

Getting Started steps for setting up your account and working with Git & Gerrit and other tools (if you haven't done this already).

Building, Hacking and Testing your patches

First you will need some packages: git and git-review

Then git clone the project (with your ssh key). For example, to propose a patch to BGS (git repo name genesis):

git clone ssh://<yourname>

Prepare for git review

git review -s

If you run into troubles, like "We don't know where your gerrit is. Please manually create a remote named "gerrit" and try again." you may need to manually add a remote

git remote add gerrit ssh://<yourname><RELEVANT_REPO>.git

…do the work on files…

git add .
git commit --signoff --all

Add a description to your commit based on below etiquette.

  • Provide a brief description of the change in the first line.
  • Insert a single blank line after the first line.
  • Provide a detailed description of the change in the following lines. Use breaking paragraphs where needed.
  • The first line should be limited to 50 characters and should not end with a period.
  • Subsequent lines should be wrapped at 72 characters.
  • Use present tense.
  • Add Jira issue no. (format JIRA: XYZ-12345)

Send your commit for review.

git review

If you need to update a previous commit, you can use:

git commit --amend
git review


Jenkins is an extensible open source continuous integration server. See more details at OPNFV Jenkins wiki or here.

Tips & Tricks

Coding Guidelines

Developer contribution/coding guidelines can be found here: OPNFV Coding Guidelines

Secure coding guidesline can be found here: OPNFV Secure Coding Guidelines

developer.1444328377.txt.gz · Last modified: 2015/10/08 18:19 by Ray Paik