Skip to content

Commit 232544f

Browse files
committed
Add CONTRIBUTING.md
Signed-off-by: Manuel Mendez <[email protected]>
1 parent 1ebcf48 commit 232544f

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
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+
### Environment Details
15+
16+
Building is handled by `make`, please see the [Makefile](Makefile) for available targets.
17+
18+
#### Nix
19+
20+
This repo's build environment can be reproduced using `nix`.
21+
22+
##### Install Nix
23+
24+
Follow the [Nix installation](https://nixos.org/download.html) guide to setup Nix on your box.
25+
26+
##### Load Dependencies
27+
28+
Loading build dependencies is as simple as running `nix-shell` or using [lorri](https://github.com/nix-community/lorri).
29+
If you have `direnv` installed the included `.envrc` will make that step automatic.
30+
31+
### How to Submit Change Requests
32+
33+
Please submit change requests and / or features via [Issues](https://github.com/tinkerbell/sandbox/issues).
34+
There's no guarantee it'll be changed, but you never know until you try.
35+
We'll try to add comments as soon as possible, though.
36+
37+
### How to Report a Bug
38+
39+
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).
40+
41+
## Code Style Guides

0 commit comments

Comments
 (0)