1# Contributing
2
3We welcome contributions from the community. Please read the following guidelines carefully to maximize the chances of your PR being merged.
4
5## Coding Style
6
7- To ensure your change passes format checks, run `make check`. To format your files, you can run `make format`.
8- We follow standard Go table-driven tests and use an internal [testing library](./internal/testing/require) to assert correctness. To verify all tests pass, you can run `make test`.
9
10## DCO
11
12We require DCO signoff line in every commit to this repo.
13
14The sign-off is a simple line at the end of the explanation for the
15patch, which certifies that you wrote it or otherwise have the right to
16pass it on as an open-source patch. The rules are pretty simple: if you
17can certify the below (from
18[developercertificate.org](https://developercertificate.org/)):
19
20```
21Developer Certificate of Origin
22Version 1.1
23Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
24660 York Street, Suite 102,
25San Francisco, CA 94110 USA
26Everyone is permitted to copy and distribute verbatim copies of this
27license document, but changing it is not allowed.
28Developer's Certificate of Origin 1.1
29By making a contribution to this project, I certify that:
30(a) The contribution was created in whole or in part by me and I
31 have the right to submit it under the open source license
32 indicated in the file; or
33(b) The contribution is based upon previous work that, to the best
34 of my knowledge, is covered under an appropriate open source
35 license and I have the right under that license to submit that
36 work with modifications, whether created in whole or in part
37 by me, under the same open source license (unless I am
38 permitted to submit under a different license), as indicated
39 in the file; or
40(c) The contribution was provided directly to me by some other
41 person who certified (a), (b) or (c) and I have not modified
42 it.
43(d) I understand and agree that this project and the contribution
44 are public and that a record of the contribution (including all
45 personal information I submit with it, including my sign-off) is
46 maintained indefinitely and may be redistributed consistent with
47 this project or the open source license(s) involved.
48```
49
50then you just add a line to every git commit message:
51
52 Signed-off-by: Joe Smith <joe@gmail.com>
53
54using your real name (sorry, no pseudonyms or anonymous contributions.)
55
56You can add the sign off when creating the git commit via `git commit -s`.
57
58## Code Reviews
59
60* The pull request title should describe what the change does and not embed issue numbers.
61The pull request should only be blank when the change is minor. Any feature should include
62a description of the change and what motivated it. If the change or design changes through
63review, please keep the title and description updated accordingly.
64* A single approval is sufficient to merge. If a reviewer asks for
65changes in a PR they should be addressed before the PR is merged,
66even if another reviewer has already approved the PR.
67* During the review, address the comments and commit the changes
68_without_ squashing the commits. This facilitates incremental reviews
69since the reviewer does not go through all the code again to find out
70what has changed since the last review. When a change goes out of sync with main,
71please rebase and force push, keeping the original commits where practical.
72* Commits are squashed prior to merging a pull request, using the title
73as commit message by default. Maintainers may request contributors to
74edit the pull request tite to ensure that it remains descriptive as a
75commit message. Alternatively, maintainers may change the commit message directly.
View as plain text