Skip to content

Commit efb56d1

Browse files
author
Ian Campbell
committed
Tailor documentation for Hyperkit
Also rename output binaries. Signed-off-by: Ian Campbell <[email protected]>
1 parent a0a82cb commit efb56d1

8 files changed

+435
-218
lines changed

CONTRIBUTING.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contributing to Docker open source projects
2+
3+
Want to hack on this project? Awesome! Here are instructions to get you started.
4+
5+
This project is a part of the [Docker](https://www.docker.com) project, and follows
6+
the same rules and principles. If you're already familiar with the way
7+
Docker does things, you'll feel right at home.
8+
9+
Otherwise, go read Docker's
10+
[contributions guidelines](https://github.com/docker/docker/blob/master/CONTRIBUTING.md),
11+
[issue triaging](https://github.com/docker/docker/blob/master/project/ISSUE-TRIAGE.md),
12+
[review process](https://github.com/docker/docker/blob/master/project/REVIEWING.md) and
13+
[branches and tags](https://github.com/docker/docker/blob/master/project/BRANCHES-AND-TAGS.md).
14+
15+
For an in-depth description of our contribution process, visit the
16+
contributors guide: [Understand how to contribute](https://docs.docker.com/opensource/workflow/make-a-contribution/)
17+
18+
### Sign your work
19+
20+
The sign-off is a simple line at the end of the explanation for the patch. Your
21+
signature certifies that you wrote the patch or otherwise have the right to pass
22+
it on as an open-source patch. The rules are pretty simple: if you can certify
23+
the below (from [developercertificate.org](http://developercertificate.org/)):
24+
25+
```
26+
Developer Certificate of Origin
27+
Version 1.1
28+
29+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
30+
660 York Street, Suite 102,
31+
San Francisco, CA 94110 USA
32+
33+
Everyone is permitted to copy and distribute verbatim copies of this
34+
license document, but changing it is not allowed.
35+
36+
Developer's Certificate of Origin 1.1
37+
38+
By making a contribution to this project, I certify that:
39+
40+
(a) The contribution was created in whole or in part by me and I
41+
have the right to submit it under the open source license
42+
indicated in the file; or
43+
44+
(b) The contribution is based upon previous work that, to the best
45+
of my knowledge, is covered under an appropriate open source
46+
license and I have the right under that license to submit that
47+
work with modifications, whether created in whole or in part
48+
by me, under the same open source license (unless I am
49+
permitted to submit under a different license), as indicated
50+
in the file; or
51+
52+
(c) The contribution was provided directly to me by some other
53+
person who certified (a), (b) or (c) and I have not modified
54+
it.
55+
56+
(d) I understand and agree that this project and the contribution
57+
are public and that a record of the contribution (including all
58+
personal information I submit with it, including my sign-off) is
59+
maintained indefinitely and may be redistributed consistent with
60+
this project or the open source license(s) involved.
61+
```
62+
63+
Then you just add a line to every git commit message:
64+
65+
Signed-off-by: Joe Smith <[email protected]>
66+
67+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
68+
69+
If you set your `user.name` and `user.email` git configs, you can sign your
70+
commit automatically with `git commit -s`.

MAINTAINERS

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Hyperkit maintainers file
2+
#
3+
# This file describes who runs the docker/hyperkit project and how.
4+
# This is a living document - if you see something out of date or missing, speak up!
5+
#
6+
# It is structured to be consumable by both humans and programs.
7+
# To extract its contents programmatically, use any TOML-compliant
8+
# parser.
9+
#
10+
# This file is compiled into the MAINTAINERS file in docker/opensource.
11+
#
12+
[Org]
13+
[Org."Core maintainers"]
14+
people = [
15+
"avsm",
16+
"djs55",
17+
"dsheets",
18+
"gdevillele",
19+
"ijc25",
20+
"justincormack",
21+
"MagnusS",
22+
"rneugeba",
23+
"samoht",
24+
]
25+
26+
[people]
27+
28+
# A reference list of all people associated with the project.
29+
# All other sections should refer to people by their canonical key
30+
# in the people section.
31+
32+
# ADD YOURSELF HERE IN ALPHABETICAL ORDER
33+
34+
[people.avsm]
35+
Name = "Anil Madhavapeddy"
36+
37+
GitHub = "avsm"
38+
39+
[people.djs55]
40+
Name = "David Scott"
41+
42+
GitHub = "djs55"
43+
44+
[people.dsheets]
45+
Name = "David Sheets"
46+
47+
GitHub = "dsheets"
48+
49+
[people.gdevillele]
50+
Name = "Gaetan de Villele"
51+
52+
GitHub = "gdevillele"
53+
54+
[people.ijc25]
55+
Name = "Ian Campbell"
56+
57+
GitHub = "ijc25"
58+
59+
[people.justincormack]
60+
Name = "Justin Cormack"
61+
62+
GitHub = "justincormack"
63+
64+
[people.MagnusS]
65+
Name = "Magnus Skjegstad"
66+
67+
GitHub = "MagnusS"
68+
69+
[people.rneugeba]
70+
Name = "Rolf Neugebauer"
71+
72+
GitHub = "rneugeba"
73+
74+
[people.samoht]
75+
Name = "Thomas Gazagnaire"
76+
77+
GitHub = "samoht"

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ INC := -Iinclude
117117

118118
CFLAGS += -DVERSION=\"$(GIT_VERSION)\"
119119

120-
TARGET = build/xhyve
120+
TARGET = build/com.docker.hyperkit
121121

122122
all: $(TARGET) | build
123123

0 commit comments

Comments
 (0)