2017-09-26 12:50:20 +00:00
|
|
|
# How to Contribute
|
|
|
|
|
|
|
|
|
|
Multus CNI is [Apache 2.0 licensed](LICENSE) 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
|
|
|
|
|
|
2017-09-26 12:53:10 +00:00
|
|
|
Please follows the standard formatting recommendations and language idioms set out
|
2017-09-26 12:50:20 +00:00
|
|
|
in [Effective Go](https://golang.org/doc/effective_go.html) and in the
|
|
|
|
|
[Go Code Review Comments wiki](https://github.com/golang/go/wiki/CodeReviewComments).
|
|
|
|
|
|
|
|
|
|
## Certificate of Origin
|
|
|
|
|
|
2017-09-26 12:52:39 +00:00
|
|
|
In order to get a clear contribution chain of trust we use the [signed-off-by language](https://01.org/community/signed-process)
|
2017-09-26 12:50:20 +00:00
|
|
|
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: <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: Abc Xyz <abc.xyz@intel.com>
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Pull requests
|
|
|
|
|
|
|
|
|
|
We accept github pull requests.
|
|
|
|
|
|
|
|
|
|
## Email and Chat
|
|
|
|
|
|
|
|
|
|
The project uses the Slack chat:
|
|
|
|
|
- Slack: #[Intel-Corp](https://intel-corp.herokuapp.com/) channel on slack
|
