From 55ff08bc250b0954e23cb7d488decf4645979db8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20Zieli=C5=84ski?= Date: Wed, 20 Mar 2024 14:25:23 +0100 Subject: [PATCH] Update README --- docs/contributing.md => CONTRIBUTING.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) rename docs/contributing.md => CONTRIBUTING.md (73%) diff --git a/docs/contributing.md b/CONTRIBUTING.md similarity index 73% rename from docs/contributing.md rename to CONTRIBUTING.md index 280f7a6..d22e4a3 100644 --- a/docs/contributing.md +++ b/CONTRIBUTING.md @@ -1,8 +1,16 @@ -## Contributing your Blueprint +## Contributing Guidelines -We encourage you to contribute your own Blueprints to this repository! To make the process smooth, please follow these guidelines: +We encourage you to contribute your own Blueprints to this repository! -To add a Blueprint to this repository, submit it as a Pull Request to this repository. +### Building your first Blueprint + +See [Building your first Blueprint](./docs/how-to-build-a-blueprint/your-first-blueprint.md). + +### Submitting your Blueprint to this repository + +To keep the submission process smooth, please follow the following guidelines: + +Submit your Blueprint as a Pull Request to this repository. Your Pull Request must contain a single `blueprint.json` file under a path `blueprints/your-blueprint-name/blueprint.json`. @@ -34,3 +42,7 @@ Here's an example: } } ``` + +### Needing Help? + +If you have questions or need assistance, start a new issue in this repository.