Unverified Commit ad1a40a9 authored by David Nuzik's avatar David Nuzik Committed by GitHub

Small updates to CONTRIBUTING (#3734)

* Capitalize k3s * Mention in Opening PRs and organizing commits section the need for signoff on commits and link to DCO section Signed-off-by: 's avatarDavid Nuzik <david.nuzik@rancher.com> Co-authored-by: 's avatarDerek Nola <derek.nola@suse.com>
parent 933052a0
# Contributing to k3s #
# Contributing to K3s #
Thanks for taking the time to contribute to k3s!
Thanks for taking the time to contribute to K3s!
Please review and follow the [Code of Conduct](https://github.com/k3s-io/k3s/blob/master/CODE_OF_CONDUCT.md).
Contributing is not limited to writing code and submitting a PR. Feel free to submit an [issue](https://github.com/k3s-io/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/).
......@@ -12,8 +14,6 @@ If you're interested in contributing documentation, please note the following:
If you're interested in contributing new tests, please see the `TESTING.md` in the tests directory.
## Pull request and git commit guidance
### Opening PRs and organizing commits
PRs should generally address only 1 issue at a time. If you need to fix two bugs, open two separate PRs. This will keep the scope of your pull requests smaller and allow them to be reviewed and merged more quickly.
......@@ -25,6 +25,8 @@ Generally, pull requests should consist of a single logical commit. However, if
The other exception to this single-commit rule is if your PR includes a change to a vendored dependency or generated code. To make reviewing easier, these changes should be segregated into their own commit. Note that as we migrate from using the vendor directory to a pure go module model for our projects, this will be less of an issue.
For each commit, please ensure you sign off as mentioned below in the [Developer Certificate Of Origin section](#developer-certificate-of-origin).
### Writing good commit messages
Git commit messages should explain the how and why of your change and be separated into a brief subject line followed by a more detailed body. When in doubt, follow this guide for good commit messages and you can’t go wrong: https://chris.beams.io/posts/git-commit/.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment