Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

40 lines (28 loc) · 1.23 KB

How to Contribute

The Ramen project is under Apache 2.0 license. We accept contributions via GitHub pull requests. This document outlines some of the conventions related to development workflow to make it easier to get your contribution accepted.

Certificate of Origin

By contributing to this project you agree to the Developer Certificate of Origin (DCO). This document was created by the Linux Kernel community and is a simple statement that you, as a contributor, have the legal right to make the contribution. See the DCO file for details.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages. For example:

This is my commit message

Signed-off-by: Random J Developer <random@developer.example.org>

Coding Style

Ramen project is written in golang and follows the style guidelines dictated by the go fmt as well as go vet tools.

Additionally various golang linters are enforced to ensure consistent coding style.

Getting Started

  1. Read the devel-quick-start guide for build, test and contributing instructions.