2017-08-02 17:27:17 +00:00
|
|
|
# Contributing
|
2018-11-17 18:01:14 +00:00
|
|
|
|
2018-12-05 15:50:46 +00:00
|
|
|
## CHANGELOG
|
|
|
|
|
|
|
|
Authors are expected to include a changelog file with their pull requests. The changelog file
|
|
|
|
should be a new file created in the `changelogs/unreleased` folder. The file should follow the
|
2018-12-05 18:25:37 +00:00
|
|
|
naming convention of `pr-username` and the contents of the file should be your text for the
|
2018-12-05 15:50:46 +00:00
|
|
|
changelog.
|
|
|
|
|
2019-01-25 03:33:07 +00:00
|
|
|
velero/changelogs/unreleased <- folder
|
2018-12-05 15:50:46 +00:00
|
|
|
000-username <- file
|
2018-11-17 18:01:14 +00:00
|
|
|
|
|
|
|
|
2017-08-02 17:27:17 +00:00
|
|
|
## DCO Sign off
|
|
|
|
|
|
|
|
All authors to the project retain copyright to their work. However, to ensure
|
|
|
|
that they are only submitting work that they have rights to, we are requiring
|
2017-10-11 15:37:42 +00:00
|
|
|
everyone to acknowledge this by signing their work.
|
2017-08-02 17:27:17 +00:00
|
|
|
|
2019-04-29 19:33:54 +00:00
|
|
|
Any copyright notices in this repo should specify the authors as "the Velero contributors".
|
2017-08-02 17:27:17 +00:00
|
|
|
|
|
|
|
To sign your work, just add a line like this at the end of your commit message:
|
|
|
|
|
|
|
|
```
|
|
|
|
Signed-off-by: Joe Beda <joe@heptio.com>
|
|
|
|
```
|
|
|
|
|
|
|
|
This can easily be done with the `--signoff` option to `git commit`.
|
|
|
|
|
|
|
|
By doing this you state that you can certify the following (from https://developercertificate.org/):
|
|
|
|
|
|
|
|
```
|
|
|
|
Developer Certificate of Origin
|
|
|
|
Version 1.1
|
|
|
|
|
|
|
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
|
|
|
1 Letterman Drive
|
|
|
|
Suite D4700
|
|
|
|
San Francisco, CA, 94129
|
|
|
|
|
|
|
|
Everyone is permitted to copy and distribute verbatim copies of this
|
|
|
|
license document, but changing it is not allowed.
|
|
|
|
|
|
|
|
|
|
|
|
Developer's Certificate of Origin 1.1
|
|
|
|
|
|
|
|
By making a contribution to this project, I certify that:
|
|
|
|
|
|
|
|
(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
|
|
|
|
|
|
|
|
(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
|
|
|
|
|
|
|
|
(c) The contribution was provided directly to me by some other
|
|
|
|
person who certified (a), (b) or (c) and I have not modified
|
|
|
|
it.
|
|
|
|
|
|
|
|
(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.
|
|
|
|
```
|