From 9756d8a528f494fdc3d2888142b845a20a164ed0 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Sat, 13 Jan 2024 00:41:59 +0100 Subject: [PATCH] Document core development ideas (#3184) --- docs/docs/92-development/01-getting-started.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/docs/92-development/01-getting-started.md b/docs/docs/92-development/01-getting-started.md index 0889afa5b..367e58284 100644 --- a/docs/docs/92-development/01-getting-started.md +++ b/docs/docs/92-development/01-getting-started.md @@ -1,5 +1,12 @@ # Getting started +## Core ideas + +- A (e.g. pipeline) configuration should never be [turing complete](https://en.wikipedia.org/wiki/Turing_completeness) (We have agents to exec things 🙂). +- If possible follow the [KISS principle](https://en.wikipedia.org/wiki/KISS_principle). +- What is used most should be default. +- Keep different topics separated, so you can write plugins, port new ideas ... more easily, see [Architecture](./05-architecture.md). + You can develop on your local computer by following the [steps below](#preparation-for-local-development) or you can start with a fully prepared online setup using [Gitpod](https://github.com/gitpod-io/gitpod) and [Gitea](https://github.com/go-gitea/gitea). ## Gitpod