Skip to content
This repository was archived by the owner on Mar 24, 2020. It is now read-only.

Commit 7f6da42

Browse files
committed
add license, and files for opensourcing
Signed-off-by: Sebastiaan van Stijn <[email protected]>
1 parent 98f706a commit 7f6da42

File tree

4 files changed

+513
-0
lines changed

4 files changed

+513
-0
lines changed

CONTRIBUTING.md

Lines changed: 263 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,263 @@
1+
# Contributing to LinuxKit
2+
3+
Want to hack on this project? Awesome! Here are instructions to get you started.
4+
5+
Additional information can be found in the docs:
6+
[issue triage](https://github.com/docker/linuxkit/blob/master/docs/issue-triage.md),
7+
and [review process](https://github.com/docker/linuxkit/blob/master/docs/reviewing.md).
8+
9+
## Reporting security issues
10+
11+
The LinuxKit maintainers take security seriously. If you discover a security
12+
issue, please bring it to their attention right away!
13+
14+
Please **DO NOT** file a public issue, instead send your report privately to
15+
16+
17+
Security reports are greatly appreciated and we will publicly thank you for it.
18+
We also like to send gifts&mdash;if you're into Docker schwag, make sure to let
19+
us know. We currently do not offer a paid security bounty program, but are not
20+
ruling it out in the future.
21+
22+
## Reporting other issues
23+
24+
A great way to contribute to the project is to send a detailed report when you
25+
encounter an issue. We always appreciate a well-written, thorough bug report,
26+
and will thank you for it!
27+
28+
Check that [our issue database](https://github.com/docker/linuxkit/issues)
29+
doesn't already include that problem or suggestion before submitting an issue.
30+
If you find a match, you can use the "subscribe" button to get notified on
31+
updates. Do *not* leave random "+1" or "I have this too" comments, as they
32+
only clutter the discussion, and don't help resolving it. However, if you
33+
have ways to reproduce the issue or have additional information that may help
34+
resolving the issue, please leave a comment.
35+
36+
Also include the steps required to reproduce the problem if possible and
37+
applicable. This information will help us review and fix your issue faster.
38+
When sending lengthy log-files, consider posting them as a gist (https://gist.github.com).
39+
Don't forget to remove sensitive data from your logfiles before posting (you can
40+
replace those parts with "REDACTED").
41+
42+
## Quick contribution tips and guidelines
43+
44+
This section gives the experienced contributor some tips and guidelines.
45+
46+
### Pull requests are always welcome
47+
48+
Not sure if that typo is worth a pull request? Found a bug and know how to fix
49+
it? Do it! We will appreciate it. Any significant improvement should be
50+
documented as [a GitHub issue](https://github.com/docker/linuxkit/issues) before
51+
anybody starts working on it.
52+
53+
We are always thrilled to receive pull requests. We do our best to process them
54+
quickly. If your pull request is not accepted on the first try, don't get
55+
discouraged! Our contributor's guide explains [the review process we
56+
use for simple changes](https://docs.docker.com/opensource/workflow/make-a-contribution/).
57+
58+
### Design and cleanup proposals
59+
60+
You can propose new designs for existing features. You can also design
61+
entirely new features. We really appreciate contributors who want to refactor or
62+
otherwise cleanup our project. For information on making these types of
63+
contributions, see [the advanced contribution
64+
section](https://docs.docker.com/opensource/workflow/advanced-contributing/) in
65+
the contributors guide.
66+
67+
We try hard to keep LinuxKit lean and focused. LinuxKit can't do everything for
68+
everybody. This means that we might decide against incorporating a new feature.
69+
However, there might be a way to implement that feature *on top of* LinuxKit.
70+
71+
### Commit Messages
72+
73+
Commit messages must start with a capitalized and short summary (max. 50 chars)
74+
written in the imperative, followed by an optional, more detailed explanatory
75+
text which is separated from the summary by an empty line.
76+
77+
Commit messages should follow best practices, including explaining the context
78+
of the problem and how it was solved, including in caveats or follow up changes
79+
required. They should tell the story of the change and provide readers
80+
understanding of what led to it.
81+
82+
If you're lost about what this even means, please see [How to Write a Git
83+
Commit Message](http://chris.beams.io/posts/git-commit/) for a start.
84+
85+
In practice, the best approach to maintaining a nice commit message is to
86+
leverage a `git add -p` and `git commit --amend` to formulate a solid
87+
changeset. This allows one to piece together a change, as information becomes
88+
available.
89+
90+
If you squash a series of commits, don't just submit that. Re-write the commit
91+
message, as if the series of commits was a single stroke of brilliance.
92+
93+
That said, there is no requirement to have a single commit for a PR, as long as
94+
each commit tells the story. For example, if there is a feature that requires a
95+
package, it might make sense to have the package in a separate commit then have
96+
a subsequent commit that uses it.
97+
98+
Remember, you're telling part of the story with the commit message. Don't make
99+
your chapter weird.
100+
101+
102+
### Review
103+
104+
Code review comments may be added to your pull request. Discuss, then make the
105+
suggested modifications and push additional commits to your feature branch. Post
106+
a comment after pushing. New commits show up in the pull request automatically,
107+
but the reviewers are notified only when you comment.
108+
109+
Pull requests must be cleanly rebased on top of master without multiple branches
110+
mixed into the PR.
111+
112+
**Git tip**: If your PR no longer merges cleanly, use `rebase master` in your
113+
feature branch to update your pull request rather than `merge master`.
114+
115+
Before you make a pull request, squash your commits into logical units of work
116+
using `git rebase -i` and `git push -f`. A logical unit of work is a consistent
117+
set of patches that should be reviewed together: for example, upgrading the
118+
version of a vendored dependency and taking advantage of its now available new
119+
feature constitute two separate units of work. Implementing a new function and
120+
calling it in another file constitute a single logical unit of work. The very
121+
high majority of submissions should have a single commit, so if in doubt: squash
122+
down to one.
123+
124+
After every commit, [make sure the test suite passes]
125+
(https://docs.docker.com/opensource/project/test-and-docs/). Include documentation
126+
changes in the same pull request so that a revert would remove all traces of
127+
the feature or fix.
128+
129+
Include an issue reference like `Closes #XXXX` or `Fixes #XXXX` in commits that
130+
close an issue. Including references automatically closes the issue on a merge.
131+
132+
### Merge approval
133+
134+
Docker maintainers use LGTM (Looks Good To Me) in comments or GitHub approval
135+
on the code review to indicate acceptance.
136+
137+
A change requires at least one LGTM from a maintainers of each component
138+
affected. A list of maintainers can be found in the [MAINTAINERS](MAINTAINERS)
139+
file.
140+
141+
### Community Guidelines and Code of Conduct
142+
143+
When contributing to this project, we expect you to respect our community
144+
guidelines and [code of conduct](https://github.com/docker/code-of-conduct)
145+
146+
We want to keep the community awesome, growing and collaborative. We need your
147+
help to keep it that way. To help with this we've come up with some general
148+
guidelines for the community as a whole:
149+
150+
* Be nice: Be courteous, respectful and polite to fellow community members:
151+
no regional, racial, gender, or other abuse will be tolerated. We like
152+
nice people way better than mean ones!
153+
154+
* Encourage diversity and participation: Make everyone in our community feel
155+
welcome, regardless of their background and the extent of their
156+
contributions, and do everything possible to encourage participation in
157+
our community.
158+
159+
* Keep it legal: Basically, don't get us in trouble. Share only content that
160+
you own, do not share private or sensitive information, and don't break
161+
the law.
162+
163+
* Stay on topic: Make sure that you are posting to the correct channel and
164+
avoid off-topic discussions. Remember when you update an issue or respond
165+
to an email you are potentially sending to a large number of people. Please
166+
consider this before you update. Also remember that nobody likes spam.
167+
168+
* Don't send email to the maintainers: There's no need to send email to the
169+
maintainers to ask them to investigate an issue or to take a look at a
170+
pull request. Instead of sending an email, GitHub mentions should be
171+
used to ping maintainers to review a pull request, a proposal or an
172+
issue.
173+
174+
### Guideline violations — 3 strikes method
175+
176+
The point of this section is not to find opportunities to punish people, but we
177+
do need a fair way to deal with people who are making our community suck.
178+
179+
1. First occurrence: We'll give you a friendly, but public reminder that the
180+
behavior is inappropriate according to our guidelines.
181+
182+
2. Second occurrence: We will send you a private message with a warning that
183+
any additional violations will result in removal from the community.
184+
185+
3. Third occurrence: Depending on the violation, we may need to delete or ban
186+
your account.
187+
188+
**Notes:**
189+
190+
* Obvious spammers are banned on first occurrence. If we don't do this, we'll
191+
have spam all over the place.
192+
193+
* Violations are forgiven after 6 months of good behavior, and we won't hold a
194+
grudge.
195+
196+
* People who commit minor infractions will get some education, rather than
197+
hammering them in the 3 strikes process.
198+
199+
* The rules apply equally to everyone in the community, no matter how much
200+
you've contributed.
201+
202+
* Extreme violations of a threatening, abusive, destructive or illegal nature
203+
will be addressed immediately and are not subject to 3 strikes or forgiveness.
204+
205+
* Contact [email protected] to report abuse or appeal violations. In the case of
206+
appeals, we know that mistakes happen, and we'll work with you to come up with a
207+
fair solution if there has been a misunderstanding.
208+
209+
### Sign your work
210+
211+
The sign-off is a simple line at the end of the explanation for the patch. Your
212+
signature certifies that you wrote the patch or otherwise have the right to pass
213+
it on as an open-source patch. The rules are pretty simple: if you can certify
214+
the below (from [developercertificate.org](http://developercertificate.org/)):
215+
216+
```
217+
Developer Certificate of Origin
218+
Version 1.1
219+
220+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
221+
1 Letterman Drive
222+
Suite D4700
223+
San Francisco, CA, 94129
224+
225+
Everyone is permitted to copy and distribute verbatim copies of this
226+
license document, but changing it is not allowed.
227+
228+
229+
Developer's Certificate of Origin 1.1
230+
231+
By making a contribution to this project, I certify that:
232+
233+
(a) The contribution was created in whole or in part by me and I
234+
have the right to submit it under the open source license
235+
indicated in the file; or
236+
237+
(b) The contribution is based upon previous work that, to the best
238+
of my knowledge, is covered under an appropriate open source
239+
license and I have the right under that license to submit that
240+
work with modifications, whether created in whole or in part
241+
by me, under the same open source license (unless I am
242+
permitted to submit under a different license), as indicated
243+
in the file; or
244+
245+
(c) The contribution was provided directly to me by some other
246+
person who certified (a), (b) or (c) and I have not modified
247+
it.
248+
249+
(d) I understand and agree that this project and the contribution
250+
are public and that a record of the contribution (including all
251+
personal information I submit with it, including my sign-off) is
252+
maintained indefinitely and may be redistributed consistent with
253+
this project or the open source license(s) involved.
254+
```
255+
256+
Then you just add a line to every git commit message:
257+
258+
Signed-off-by: Joe Smith <[email protected]>
259+
260+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
261+
262+
If you set your `user.name` and `user.email` git configs, you can sign your
263+
commit automatically with `git commit -s`.

0 commit comments

Comments
 (0)