CONTRIBUTING.md

Hello Contributors!

Thanks for your interest! We're so glad you're here.

Important Resources

bugs: https://github.com/tinkerbell/playground/issues

Code of Conduct

Please read and understand the code of conduct found here.

DCO Sign Off

Please read and understand the DCO found here.

Environment Details

Building is handled by make, please see the Makefile for available targets.

Nix

This repo's build environment can be reproduced using nix.

Install Nix

Follow the Nix installation guide to setup Nix on your box.

Load Dependencies

Loading build dependencies is as simple as running nix-shell or using 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. 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.

Code Style Guides

Implementation Details

The Playground is organized into two high level components: infrastructure and stack.

• The infrastructure component is responsible for provisioning the infrastructure required to run the Tinkerbell stack. Vagrant and Terraform are the supported infrastructure tools.
• The stack component is responsible for provisioning the Tinkerbell stack itself. Docker Compose and Helm are the supported stack tools.