k3s/CONTRIBUTING.md

28 lines
1.8 KiB
Markdown
Raw Normal View History

2020-06-23 15:54:18 +00:00
# Contributing to k3s #
Thanks for taking the time to contribute to k3s!
2020-06-23 15:54:18 +00:00
Contributing is not limited to writing code and submitting a PR. Feel free to submit an [issue](https://github.com/rancher/k3s/issues/new/choose) or comment on an existing one to report a bug, provide feedback, or suggest a new feature. You can also join the discussion on [slack](https://slack.rancher.io/).
2020-06-23 15:54:18 +00:00
Of course, contributing code is more than welcome! To keep things simple, if you're fixing a small issue, you can simply submit a PR and we will pick it up. However, if you're planning to submit a bigger PR to implement a new feature or fix a relatively complex bug, please open an issue that explains the change and the motivation for it. If you're addressing a bug, please explain how to reproduce it.
2020-06-23 15:54:18 +00:00
If you're interested in contributing documentation, please note the following:
- Doc issues are raised in this repository, and they are tracked under the `kind/documentation` label.
- Pull requests are submitted to the K3s documentation source in the [Rancher docs repository.](https://github.com/rancher/docs/) The K3s docs content is in the `content/k3s/` directory.
## Developer Certificate Of Origin ##
2020-06-23 15:54:18 +00:00
To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal rite to make the contribution.
2020-06-23 15:54:18 +00:00
See the [DCO](DCO) file for the full text of what you must agree to.
2020-06-23 15:54:18 +00:00
To signify that you agree to the DCO for a commit, you add a line to the git
commit message:
2020-06-23 15:54:18 +00:00
```txt
Signed-off-by: Jane Smith <jane.smith@example.com>
2020-06-23 15:54:18 +00:00
```
In most cases, you can add this signoff to your commit automatically with the
`-s` flag to `git commit`. Please use your real name and a reachable email address.