Skip to content

Commit 5ad14db

Browse files
committed
*: add contribution guide and DCO
Not sure why these have been missing for so long. Pulled from coreos/template-project as per other CoreOS projects.
1 parent 716ff80 commit 5ad14db

File tree

2 files changed

+113
-0
lines changed

2 files changed

+113
-0
lines changed

CONTRIBUTING.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# How to Contribute
2+
3+
CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via
4+
GitHub pull requests. This document outlines some of the conventions on
5+
development workflow, commit message formatting, contact points and other
6+
resources to make it easier to get your contribution accepted.
7+
8+
# Certificate of Origin
9+
10+
By contributing to this project you agree to the Developer Certificate of
11+
Origin (DCO). This document was created by the Linux Kernel community and is a
12+
simple statement that you, as a contributor, have the legal right to make the
13+
contribution. See the [DCO](DCO) file for details.
14+
15+
# Email and Chat
16+
17+
The project currently uses the general CoreOS email list and IRC channel:
18+
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev)
19+
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org
20+
21+
Please avoid emailing maintainers found in the MAINTAINERS file directly. They
22+
are very busy and read the mailing lists.
23+
24+
## Getting Started
25+
26+
- Fork the repository on GitHub
27+
- Read the [README](README.md) for build and test instructions
28+
- Play with the project, submit bugs, submit patches!
29+
30+
## Contribution Flow
31+
32+
This is a rough outline of what a contributor's workflow looks like:
33+
34+
- Create a topic branch from where you want to base your work (usually master).
35+
- Make commits of logical units.
36+
- Make sure your commit messages are in the proper format (see below).
37+
- Push your changes to a topic branch in your fork of the repository.
38+
- Make sure the tests pass, and add any new tests as appropriate.
39+
- Submit a pull request to the original repository.
40+
41+
Thanks for your contributions!
42+
43+
### Coding Style
44+
45+
CoreOS projects written in Go follow a set of style guidelines that we've documented
46+
[here](https://github.com/coreos/docs/tree/master/golang). Please follow them when
47+
working on your contributions.
48+
49+
### Format of the Commit Message
50+
51+
We follow a rough convention for commit messages that is designed to answer two
52+
questions: what changed and why. The subject line should feature the what and
53+
the body of the commit should describe the why.
54+
55+
```
56+
scripts: add the test-cluster command
57+
58+
this uses tmux to setup a test cluster that you can easily kill and
59+
start for debugging.
60+
61+
Fixes #38
62+
```
63+
64+
The format can be described more formally as follows:
65+
66+
```
67+
<subsystem>: <what changed>
68+
<BLANK LINE>
69+
<why this change was made>
70+
<BLANK LINE>
71+
<footer>
72+
```
73+
74+
The first line is the subject and should be no longer than 70 characters, the
75+
second line is always blank, and other lines should be wrapped at 80 characters.
76+
This allows the message to be easier to read on GitHub as well as in various
77+
git tools.

DCO

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Developer Certificate of Origin
2+
Version 1.1
3+
4+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
5+
660 York Street, Suite 102,
6+
San Francisco, CA 94110 USA
7+
8+
Everyone is permitted to copy and distribute verbatim copies of this
9+
license document, but changing it is not allowed.
10+
11+
12+
Developer's Certificate of Origin 1.1
13+
14+
By making a contribution to this project, I certify that:
15+
16+
(a) The contribution was created in whole or in part by me and I
17+
have the right to submit it under the open source license
18+
indicated in the file; or
19+
20+
(b) The contribution is based upon previous work that, to the best
21+
of my knowledge, is covered under an appropriate open source
22+
license and I have the right under that license to submit that
23+
work with modifications, whether created in whole or in part
24+
by me, under the same open source license (unless I am
25+
permitted to submit under a different license), as indicated
26+
in the file; or
27+
28+
(c) The contribution was provided directly to me by some other
29+
person who certified (a), (b) or (c) and I have not modified
30+
it.
31+
32+
(d) I understand and agree that this project and the contribution
33+
are public and that a record of the contribution (including all
34+
personal information I submit with it, including my sign-off) is
35+
maintained indefinitely and may be redistributed consistent with
36+
this project or the open source license(s) involved.

0 commit comments

Comments
 (0)