Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 1.43 KB

How to Contribute

Hardware Event Proxy is Apache 2.0 licensed and accepts contributions via GitHub pull requests. This document outlines some of the conventions on development workflow, commit message formatting, contact points and other resources to make it easier to get your contribution accepted.

Coding Style

Please 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 used by the Linux kernel project.

Format of the patch

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: <[email protected]>

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: Abc Xyz <[email protected]>

Pull requests

We accept github pull requests.