|
| 1 | +# Contributing Guidelines |
| 2 | + |
| 3 | +Contributions are welcome via GitHub pull requests. |
| 4 | +This document outlines the process to help get your contribution accepted. |
| 5 | + |
| 6 | +## Sign off Your Work |
| 7 | + |
| 8 | +The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. |
| 9 | +Here is the full text of the [DCO](http://developercertificate.org/): |
| 10 | + |
| 11 | +``` |
| 12 | +Developer Certificate of Origin |
| 13 | +Version 1.1 |
| 14 | +
|
| 15 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 16 | +1 Letterman Drive |
| 17 | +Suite D4700 |
| 18 | +San Francisco, CA, 94129 |
| 19 | +
|
| 20 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 21 | +license document, but changing it is not allowed. |
| 22 | +
|
| 23 | +
|
| 24 | +Developer's Certificate of Origin 1.1 |
| 25 | +
|
| 26 | +By making a contribution to this project, I certify that: |
| 27 | +
|
| 28 | +(a) The contribution was created in whole or in part by me and I |
| 29 | + have the right to submit it under the open source license |
| 30 | + indicated in the file; or |
| 31 | +
|
| 32 | +(b) The contribution is based upon previous work that, to the best |
| 33 | + of my knowledge, is covered under an appropriate open source |
| 34 | + license and I have the right under that license to submit that |
| 35 | + work with modifications, whether created in whole or in part |
| 36 | + by me, under the same open source license (unless I am |
| 37 | + permitted to submit under a different license), as indicated |
| 38 | + in the file; or |
| 39 | +
|
| 40 | +(c) The contribution was provided directly to me by some other |
| 41 | + person who certified (a), (b) or (c) and I have not modified |
| 42 | + it. |
| 43 | +
|
| 44 | +(d) I understand and agree that this project and the contribution |
| 45 | + are public and that a record of the contribution (including all |
| 46 | + personal information I submit with it, including my sign-off) is |
| 47 | + maintained indefinitely and may be redistributed consistent with |
| 48 | + this project or the open source license(s) involved. |
| 49 | +``` |
| 50 | + |
| 51 | +Contributors must sign-off that they adhere to these requirements by adding a `Signed-off-by` line to commit messages. |
| 52 | + |
| 53 | +``` |
| 54 | +This is my commit message |
| 55 | +
|
| 56 | +Signed-off-by: Random J Developer <[email protected]> |
| 57 | +``` |
| 58 | + |
| 59 | +Git has a `-s` command line option to append this automatically to your commit message: |
| 60 | + |
| 61 | +```console |
| 62 | +$ git commit -s -m 'This is my commit message' |
| 63 | +``` |
| 64 | + |
| 65 | +## How to Contribute |
| 66 | + |
| 67 | +1. Fork this repository, develop, and test your changes. |
| 68 | +1. Remember to sign off your commits as described above. |
| 69 | +1. Submit a pull request. |
| 70 | + |
| 71 | +***NOTE***: In order to make testing and merging of PRs easier, please submit changes to multiple charts in separate PRs. |
| 72 | + |
| 73 | +### Technical Requirements |
| 74 | + |
| 75 | +* Must pass linting and installing with the [chart-testing](https://github.com/helm/chart-testing) tool |
| 76 | +* Must follow [best practices](https://github.com/helm/helm/tree/master/docs/chart_best_practices) and [review guidelines](https://github.com/helm/charts/blob/master/REVIEW_GUIDELINES.md) |
| 77 | + |
| 78 | +### Documentation Requirements |
| 79 | + |
| 80 | +* A chart's `README.md` must include configuration options |
| 81 | +* A chart's `NOTES.txt` must include relevant post-installation information |
| 82 | + |
| 83 | +### Merge Approval and Release Process |
| 84 | + |
| 85 | +* Must pass DCO check |
| 86 | +* Must pass CI jobs for linting and installing changed charts |
| 87 | +* Any change to a chart requires a version bump following [semver](https://semver.org/) principles |
| 88 | + |
| 89 | +Once changes have been merged, the release job will automatically run to package and release changed charts. |
0 commit comments