Skip to content
This repository has been archived by the owner on Oct 17, 2022. It is now read-only.

Latest commit

 

History

History
62 lines (39 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

62 lines (39 loc) · 1.86 KB

Contributing to Configurable Cloud VM

Configurable Cloud VM is an open source project licensed under the [Apache v2 License] (https://opensource.org/licenses/Apache-2.0)

Coding Style

Configurable Cloud VM follows the standard formatting recommendations and language idioms set out in Effective Go and in the Go Code Review Comments wiki.

Certificate of Origin

In order to get a clear contribution chain of trust we use the [signed-off-by language] (https://01.org/community/signed-process) used by the Linux kernel project.

Patch format

Beside the signed-off-by footer, we expect each patch to comply with the following format:

Change summary

More detailed explanation of your changes: Why and how.
Wrap it to 72 characters.
See [here] (http://chris.beams.io/posts/git-commit/)
for some more good advices.

Fixes #NUMBER (or URL to the issue)

Signed-off-by: <contributor@foo.com>

For example:

Fix poorly named identifiers
  
One identifier, fnname, in func.go was poorly named.  It has been renamed
to fnName.  Another identifier retval was not needed and has been removed
entirely.

Fixes #1
    
Signed-off-by: Mark Ryan <mark.d.ryan@intel.com>

Pull requests

We accept github pull requests.

Quality Controls

We request you give quality assurance some consideration by:

  • Adding go unit tests for changes where it makes sense.
  • Enabling Travis CI on your github fork of Configurable Cloud VM to get continuous integration feedback on your dev/test branches.

Issue tracking

If you have a problem, please let us know. If it's a bug not already documented, by all means please open an issue in github so we all get visibility the problem and work toward resolution.