From 0b716b472025bb281f9f61e49fdaac6eeb6741fc Mon Sep 17 00:00:00 2001 From: Manuel Mendez Date: Fri, 16 Jul 2021 13:53:27 -0400 Subject: [PATCH] Add CONTRIBUTING.md Signed-off-by: Manuel Mendez --- CONTRIBUTING.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2c4947e --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +## Hello Contributors! + +Thanks for your interest! +We're so glad you're here. + +### Important Resources + +#### bugs: [https://github.com/tinkerbell/sandbox/issues](https://github.com/tinkerbell/sandbox/issues) + +### Code of Conduct + +Please read and understand the code of conduct found [here](https://github.com/tinkerbell/.github/blob/master/CODE_OF_CONDUCT.md). + +### Environment Details + +Building is handled by `make`, please see the [Makefile](Makefile) for available targets. + +#### Nix + +This repo's build environment can be reproduced using `nix`. + +##### Install Nix + +Follow the [Nix installation](https://nixos.org/download.html) guide to setup Nix on your box. + +##### Load Dependencies + +Loading build dependencies is as simple as running `nix-shell` or using [lorri](https://github.com/nix-community/lorri). +If you have `direnv` installed the included `.envrc` will make that step automatic. + +### How to Submit Change Requests + +Please submit change requests and / or features via [Issues](https://github.com/tinkerbell/sandbox/issues). +There's no guarantee it'll be changed, but you never know until you try. +We'll try to add comments as soon as possible, though. + +### How to Report a Bug + +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). + +## Code Style Guides