Skip to content

Commit 232cf79

Browse files
authored
Add/update DCO, CoC, contributing ... files (#93)
## Description Update non code files to be uniformish amongst all repos. ## Why is this needed Ensures our repos are all licensed correctly and contain similar/minimum contribution info files.
2 parents 1ebcf48 + f3bc190 commit 232cf79

File tree

2 files changed

+107
-0
lines changed

2 files changed

+107
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
## Hello Contributors!
2+
3+
Thanks for your interest!
4+
We're so glad you're here.
5+
6+
### Important Resources
7+
8+
#### bugs: [https://github.com/tinkerbell/sandbox/issues](https://github.com/tinkerbell/sandbox/issues)
9+
10+
### Code of Conduct
11+
12+
Please read and understand the code of conduct found [here](https://github.com/tinkerbell/.github/blob/master/CODE_OF_CONDUCT.md).
13+
14+
### DCO Sign Off
15+
16+
Please read and understand the DCO found [here](docs/DCO.md).
17+
18+
### Environment Details
19+
20+
Building is handled by `make`, please see the [Makefile](Makefile) for available targets.
21+
22+
#### Nix
23+
24+
This repo's build environment can be reproduced using `nix`.
25+
26+
##### Install Nix
27+
28+
Follow the [Nix installation](https://nixos.org/download.html) guide to setup Nix on your box.
29+
30+
##### Load Dependencies
31+
32+
Loading build dependencies is as simple as running `nix-shell` or using [lorri](https://github.com/nix-community/lorri).
33+
If you have `direnv` installed the included `.envrc` will make that step automatic.
34+
35+
### How to Submit Change Requests
36+
37+
Please submit change requests and / or features via [Issues](https://github.com/tinkerbell/sandbox/issues).
38+
There's no guarantee it'll be changed, but you never know until you try.
39+
We'll try to add comments as soon as possible, though.
40+
41+
### How to Report a Bug
42+
43+
Bugs are problems in code, in the functionality of an application or in its UI design; you can submit them through [Issues](https://github.com/tinkerbell/sandbox/issues).
44+
45+
## Code Style Guides

docs/DCO.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# DCO Sign Off
2+
3+
All authors to the project retain copyright to their work. However, to ensure
4+
that they are only submitting work that they have rights to, we are requiring
5+
everyone to acknowledge this by signing their work.
6+
7+
Since this signature indicates your rights to the contribution and
8+
certifies the statements below, it must contain your real name and
9+
email address. Various forms of noreply email address must not be used.
10+
11+
Any copyright notices in this repository should specify the authors as "The
12+
project authors".
13+
14+
To sign your work, just add a line like this at the end of your commit message:
15+
16+
```text
17+
Signed-off-by: Jess Owens <[email protected]>
18+
```
19+
20+
This can easily be done with the `--signoff` option to `git commit`.
21+
22+
By doing this you state that you can certify the following (from [https://developercertificate.org/][1]):
23+
24+
```text
25+
Developer Certificate of Origin
26+
Version 1.1
27+
28+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
29+
1 Letterman Drive
30+
Suite D4700
31+
San Francisco, CA, 94129
32+
33+
Everyone is permitted to copy and distribute verbatim copies of this
34+
license document, but changing it is not allowed.
35+
36+
37+
Developer's Certificate of Origin 1.1
38+
39+
By making a contribution to this project, I certify that:
40+
41+
(a) The contribution was created in whole or in part by me and I
42+
have the right to submit it under the open source license
43+
indicated in the file; or
44+
45+
(b) The contribution is based upon previous work that, to the best
46+
of my knowledge, is covered under an appropriate open source
47+
license and I have the right under that license to submit that
48+
work with modifications, whether created in whole or in part
49+
by me, under the same open source license (unless I am
50+
permitted to submit under a different license), as indicated
51+
in the file; or
52+
53+
(c) The contribution was provided directly to me by some other
54+
person who certified (a), (b) or (c) and I have not modified
55+
it.
56+
57+
(d) I understand and agree that this project and the contribution
58+
are public and that a record of the contribution (including all
59+
personal information I submit with it, including my sign-off) is
60+
maintained indefinitely and may be redistributed consistent with
61+
this project or the open source license(s) involved.
62+
```

0 commit comments

Comments
 (0)