Contribution Guidelines

To contribute to OpenNetVM, please follow these steps:

  1. Please read our style guide.
  2. Create your own fork of the OpenNetVM repository
  3. Add our master repository as an upstream remote:
1
git remote add upstream https://github.com/sdnfv/openNetVM
  1. Update the develop branch before starting your work:
1
git pull upstream develop
  1. Create a branch off of develop for your feature.

We follow the fork/branch workflow where no commits are ever made to develop or master. Instead, all development occurs on a separate feature branch. Please read this guide on the Git workflow.

  1. When contributing to documentation for ONVM, please see this Restructured Text (reST) guide for formatting.
  2. Add your commits

Good commit messages contain both a subject and body. The subject provides an overview whereas the body answers the what and why. The body is usually followed by a change list that explains the how, and the commit ends with a test plan describing how the developer verified their change. Please read this guide for more information.

  1. When you’re ready to submit a pull request, rebase against develop and clean up any merge conflicts
1
git pull --rebase upstream develop
  1. Please fill out the pull request template as best as possible and be very detailed/thorough.