Skip to content

Commit e94eb6e

Browse files
author
Craig Jellick
committed
Simplify CONTRIBUTING.md
Make the contributing guide less prescriptive and include the DCO.
1 parent 57fb660 commit e94eb6e

File tree

2 files changed

+49
-69
lines changed

2 files changed

+49
-69
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,23 @@
11
# Contributing to k3s #
22

3-
## Getting Help ##
3+
Thanks for taking the time to contribute to k3s!
44

5-
If you have a question about k3s or have encountered problems using it,
6-
start by [asking in slack](https://slack.rancher.io/).
5+
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/).
76

8-
## Submitting a Pull Request ##
7+
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.
98

10-
1. Submit an [issue][issue] describing your proposed change.
11-
2. We will try to respond to your issue promptly.
12-
3. Fork this repo, develop and test your code changes. See the project's
13-
[README](README.md) for further information about working in this repository.
14-
4. Submit a pull request against this repo's `master` branch.
15-
- Include instructions on how to test your changes.
16-
5. Your branch may be merged once all configured checks pass, including:
17-
- The branch has passed tests in CI.
18-
- Two reviews from k3s maintainers
9+
## Developer Certificate Of Origin ##
1910

20-
## Committing ##
11+
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 right to make the contribution.
2112

22-
We prefer squash or rebase commits so that all changes from a branch are
23-
committed to master as a single commit. All pull requests are squashed when
24-
merged, but rebasing prior to merge gives you better control over the commit
25-
message.
13+
See the [DCO](DCO) file for the full text of what you must agree to.
2614

27-
### Commit messages ###
28-
29-
Finalized commit messages should be in the following format:
15+
To signify that you agree to the DCO for a commit, you add a line to the git
16+
commit message:
3017

3118
```txt
32-
Subject
33-
34-
Problem
35-
36-
Solution
37-
38-
Validation
39-
40-
Fixes #[GitHub issue ID]
19+
Signed-off-by: Jane Smith <[email protected]>
4120
```
4221

43-
#### Subject ####
44-
45-
- one line, <= 50 characters
46-
- describe what is done; not the result
47-
- use the active voice
48-
- capitalize first word and proper nouns
49-
- do not end in a period — this is a title/subject
50-
- reference the GitHub issue by number
51-
52-
#### Problem ####
53-
54-
Explain the context and why you're making that change. What is the problem
55-
you're trying to solve? In some cases there is not a problem and this can be
56-
thought of as being the motivation for your change.
57-
58-
#### Solution ####
59-
60-
Describe the modifications you've made.
61-
62-
If this PR changes a behavior, it is helpful to describe the difference between
63-
the old behavior and the new behavior. Provide example CLI output, or changed
64-
YAML where applicable.
65-
66-
Describe any implementation changes which are particularly complex or
67-
unintuitive.
68-
69-
List any follow-up work that will need to be done in a future PR and link to any
70-
relevant Github issues.
71-
72-
#### Validation ####
73-
74-
Describe the testing you've done to validate your change. Give instructions for
75-
reviewers to replicate your tests. Performance-related changes should include
76-
before- and after- benchmark results.
77-
78-
[issue]: https://github.com/rancher/k3s/issues/new
79-
[slack]: http://slack.rancher.io/
80-
81-
_This contributing doc adapated from Linkerd2's contributing doc._
22+
In most cases, you can add this signoff to your commit automatically with the
23+
`-s` flag to `git commit`. Please use your real name and a reachable email address.

DCO

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
1 Letterman Drive
6+
Suite D4700
7+
San Francisco, CA, 94129
8+
9+
Everyone is permitted to copy and distribute verbatim copies of this
10+
license document, but changing it is not allowed.
11+
12+
13+
Developer's Certificate of Origin 1.1
14+
15+
By making a contribution to this project, I certify that:
16+
17+
(a) The contribution was created in whole or in part by me and I
18+
have the right to submit it under the open source license
19+
indicated in the file; or
20+
21+
(b) The contribution is based upon previous work that, to the best
22+
of my knowledge, is covered under an appropriate open source
23+
license and I have the right under that license to submit that
24+
work with modifications, whether created in whole or in part
25+
by me, under the same open source license (unless I am
26+
permitted to submit under a different license), as indicated
27+
in the file; or
28+
29+
(c) The contribution was provided directly to me by some other
30+
person who certified (a), (b) or (c) and I have not modified
31+
it.
32+
33+
(d) I understand and agree that this project and the contribution
34+
are public and that a record of the contribution (including all
35+
personal information I submit with it, including my sign-off) is
36+
maintained indefinitely and may be redistributed consistent with
37+
this project or the open source license(s) involved.
38+

0 commit comments

Comments
 (0)