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

Latest commit

 

History

History
56 lines (39 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

56 lines (39 loc) · 1.91 KB

How to Contribute

We accept contributions via GitHub pull requests. This document outlines some of the conventions related to development workflow, commit message formatting, contact points and other resources 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>

Git even has a -s command line option to append this automatically to your commit message:

$ git commit -s -m 'This is my commit message'

We use a DCO bot to enforce the DCO on each pull request and branch commits.

Getting Started

  • Fork the repository on GitHub
  • Read the README for build and test instructions
  • Play with the project, submit bugs, submit patches!

Contribution Flow

This is a rough outline of what a contributor's workflow looks like:

  • Create a branch from where you want to base your work (usually master).
  • Make your changes and arrange them in readable commits.
  • Make sure your commit messages are in the proper format (see below).
  • Push your changes to the branch in your fork of the repository.
  • Make sure all tests pass, and add any new tests as appropriate.
  • Submit a pull request to the original repository.

For detailed contribution instructions, refer to the development flow.

Coding Style

The operator kit is written in golang and follows the style guidelines dictated by the go fmt as well as go vet tools.