|
| 1 | +# How to Contribute |
| 2 | + |
| 3 | +network-operator-init-container is [Apache 2.0 licensed](LICENSE) and accepts contributions via GitHub |
| 4 | +pull requests. This document outlines some of the conventions on development |
| 5 | +workflow, commit message formatting, contact points and other resources to make |
| 6 | +it easier to get your contribution accepted. |
| 7 | + |
| 8 | +## Issue Tracking |
| 9 | + |
| 10 | +* All enhancement, bugfix, or change requests must begin with the creation of a [Issue Request](https://github.com/Mellanox/network-operator-init-container/issues). |
| 11 | + |
| 12 | + |
| 13 | +## Coding Style |
| 14 | + |
| 15 | +Please follows the standard formatting recommendations and language idioms set out |
| 16 | +in [Effective Go](https://golang.org/doc/effective_go.html) and in the |
| 17 | +[Go Code Review Comments wiki](https://github.com/golang/go/wiki/CodeReviewComments). |
| 18 | + |
| 19 | + |
| 20 | +## Signing Your Work |
| 21 | + |
| 22 | +* We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. |
| 23 | + |
| 24 | + * Any contribution which contains commits that are not Signed-Off will not be accepted. |
| 25 | + |
| 26 | +* To sign off on a commit you simply use the `--signoff` (or `-s`) option when committing your changes: |
| 27 | + ```bash |
| 28 | + $ git commit -s -m "Add cool feature." |
| 29 | + ``` |
| 30 | + This will append the following to your commit message: |
| 31 | + ``` |
| 32 | + Signed-off-by: Your Name <[email protected]> |
| 33 | + ``` |
| 34 | + |
| 35 | +* Full text of the DCO: |
| 36 | + |
| 37 | + ``` |
| 38 | + Developer Certificate of Origin |
| 39 | + Version 1.1 |
| 40 | + |
| 41 | + Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 42 | + 1 Letterman Drive |
| 43 | + Suite D4700 |
| 44 | + San Francisco, CA, 94129 |
| 45 | + |
| 46 | + Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. |
| 47 | + ``` |
| 48 | + |
| 49 | + ``` |
| 50 | + Developer's Certificate of Origin 1.1 |
| 51 | + |
| 52 | + By making a contribution to this project, I certify that: |
| 53 | + |
| 54 | + (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or |
| 55 | + |
| 56 | + (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or |
| 57 | + |
| 58 | + (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. |
| 59 | + |
| 60 | + (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. |
| 61 | + ``` |
| 62 | + |
| 63 | +## Format of the patch |
| 64 | + |
| 65 | +Beside the signed-off-by footer, we expect each patch to comply with the following format: |
| 66 | + |
| 67 | +``` |
| 68 | +Change summary |
| 69 | +
|
| 70 | +More detailed explanation of your changes: Why and how. |
| 71 | +Wrap it to 72 characters. |
| 72 | +
|
| 73 | +Signed-off-by: <[email protected]> |
| 74 | +``` |
| 75 | + |
| 76 | +## Format of PR title and description |
| 77 | + |
| 78 | +Pull Request title and description are expected to conform to [conventional commits specification](https://www.conventionalcommits.org) |
0 commit comments