1## Contribution Guidelines
2
3### Pull requests are always welcome
4
5We are always thrilled to receive pull requests, and do our best to
6process them as fast as possible. Not sure if that typo is worth a pull
7request? Do it! We will appreciate it.
8
9If your pull request is not accepted on the first try, don't be
10discouraged! If there's a problem with the implementation, hopefully you
11received feedback on what to improve.
12
13We're trying very hard to keep runc lean and focused. We don't want it
14to do everything for everybody. This means that we might decide against
15incorporating a new feature. However, there might be a way to implement
16that feature *on top of* runc.
17
18
19### Conventions
20
21Fork the repo and make changes on your fork in a feature branch:
22
23- If it's a bugfix branch, name it XXX-something where XXX is the number of the
24  issue
25- If it's a feature branch, create an enhancement issue to announce your
26  intentions, and name it XXX-something where XXX is the number of the issue.
27
28Submit unit tests for your changes.  Go has a great test framework built in; use
29it! Take a look at existing tests for inspiration. Run the full test suite on
30your branch before submitting a pull request.
31
32Update the documentation when creating or modifying features. Test
33your documentation changes for clarity, concision, and correctness, as
34well as a clean documentation build. See ``docs/README.md`` for more
35information on building the docs and how docs get released.
36
37Write clean code. Universally formatted code promotes ease of writing, reading,
38and maintenance. Always run `gofmt -s -w file.go` on each changed file before
39committing your changes. Most editors have plugins that do this automatically.
40
41Pull requests descriptions should be as clear as possible and include a
42reference to all the issues that they address.
43
44Pull requests must not contain commits from other users or branches.
45
46Commit messages must start with a capitalized and short summary (max. 50
47chars) written in the imperative, followed by an optional, more detailed
48explanatory text which is separated from the summary by an empty line.
49
50Code review comments may be added to your pull request. Discuss, then make the
51suggested modifications and push additional commits to your feature branch. Be
52sure to post a comment after pushing. The new commits will show up in the pull
53request automatically, but the reviewers will not be notified unless you
54comment.
55
56Before the pull request is merged, make sure that you squash your commits into
57logical units of work using `git rebase -i` and `git push -f`. After every
58commit the test suite should be passing. Include documentation changes in the
59same commit so that a revert would remove all traces of the feature or fix.
60
61Commits that fix or close an issue should include a reference like `Closes #XXX`
62or `Fixes #XXX`, which will automatically close the issue when merged.
63
64### Sign your work
65
66The sign-off is a simple line at the end of the explanation for the
67patch, which certifies that you wrote it or otherwise have the right to
68pass it on as an open-source patch.  The rules are pretty simple: if you
69can certify the below (from
70[developercertificate.org](http://developercertificate.org/)):
71
72```
73Developer Certificate of Origin
74Version 1.1
75
76Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
77660 York Street, Suite 102,
78San Francisco, CA 94110 USA
79
80Everyone is permitted to copy and distribute verbatim copies of this
81license document, but changing it is not allowed.
82
83
84Developer's Certificate of Origin 1.1
85
86By making a contribution to this project, I certify that:
87
88(a) The contribution was created in whole or in part by me and I
89    have the right to submit it under the open source license
90    indicated in the file; or
91
92(b) The contribution is based upon previous work that, to the best
93    of my knowledge, is covered under an appropriate open source
94    license and I have the right under that license to submit that
95    work with modifications, whether created in whole or in part
96    by me, under the same open source license (unless I am
97    permitted to submit under a different license), as indicated
98    in the file; or
99
100(c) The contribution was provided directly to me by some other
101    person who certified (a), (b) or (c) and I have not modified
102    it.
103
104(d) I understand and agree that this project and the contribution
105    are public and that a record of the contribution (including all
106    personal information I submit with it, including my sign-off) is
107    maintained indefinitely and may be redistributed consistent with
108    this project or the open source license(s) involved.
109```
110
111then you just add a line to every git commit message:
112
113    Signed-off-by: Joe Smith <joe@gmail.com>
114
115using your real name (sorry, no pseudonyms or anonymous contributions.)
116
117You can add the sign off when creating the git commit via `git commit -s`.
118