-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add DCO and contributing guide
Signed-off-by: Marvin Beckers <[email protected]>
- Loading branch information
Showing
3 changed files
with
72 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Contributing | ||
|
||
Thank you for considering to contribute to kubeconfig-bikeshed! Please see the following information regarding contributions. | ||
|
||
## License | ||
|
||
kubeconfig-bikeshed is licensed under [Apache-2.0](./LICENSE). | ||
|
||
## Developer Certificate of Origin (DCO) | ||
|
||
By contributing to kubeconfig-bikeshed you agree to the Developer Certificate of Origin (DCO), which has originally been created by the Linux Foundation for the Linux kernel developer community. It certifies that you have a legal right to ma. | ||
|
||
To sign your work, just add a line like this at the end of your commit message (this can also be done with the `--signoff` / `-S` flag): | ||
|
||
``` | ||
Signed-off-by: Joe Example <[email protected]> | ||
``` | ||
|
||
By doing so you certify that you make a contribution in accordance with the [DCO](./DCO) file in this repository. | ||
|
||
## Conventional Commits | ||
|
||
This repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) starting from May 25, 2024. [sidero/conform](https://github.com/siderolabs/conform) is used to validate and enforce it. | ||
|
||
It is possible to set up a commit hook to run `conform` on commits. This is not necessary to contribute as conventional commits can be verified with any compatible tool. | ||
|
||
```sh | ||
cat <<EOF | tee .git/hooks/commit-msg | ||
#!/bin/sh | ||
conform enforce --commit-msg-file \$1 | ||
EOF | ||
chmod +x .git/hooks/commit-msg | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters