|
1 | 1 | # Contributing to k3s #
|
2 | 2 |
|
3 |
| -## Getting Help ## |
| 3 | +Thanks for taking the time to contribute to k3s! |
4 | 4 |
|
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/). |
7 | 6 |
|
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. |
9 | 8 |
|
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 ## |
19 | 10 |
|
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. |
21 | 12 |
|
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. |
26 | 14 |
|
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: |
30 | 17 |
|
31 | 18 | ```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]> |
41 | 20 | ```
|
42 | 21 |
|
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. |
0 commit comments