From f131ee335c5d5b867027e10c8e417ab1b34eaec2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Benedikt=20Br=C3=BCckmann?= <64bit+git@posteo.de> Date: Mon, 13 Sep 2021 11:26:43 +0200 Subject: [PATCH] =?UTF-8?q?Mehr=20Prosa=20=C3=BCber=20die=20Aufteilung=20u?= =?UTF-8?q?nd=20wie=20man=20mitmachen=20kann?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index c5d48b6..6b4d76e 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,32 @@ SPDX-License-Identifier: AGPL-3.0-or-later [![Build Status](https://drone.wtf-eg.de/api/badges/kompetenzinventar/ki-backend/status.svg?ref=refs/heads/main)](https://drone.wtf-eg.de/kompetenzinventar/ki-backend) [![REUSE status](https://api.reuse.software/badge/git.wtf-eg.de/kompetenzinventar/ki-backend)](https://api.reuse.software/info/git.wtf-eg.de/kompetenzinventar/ki-backend) +## Über + +Dieses Repo enthält das Backend des Projekts Kompentenzinventar - einer Webapplikation zur Erfassung von Userprofilen für die WTF eG. + +Implementiert ist das Backend mit Flask. + +### Mitmachen + +Du kannst gerne bei der Entwicklung des Kompetenzinventars mitmachen. + +- Fehler oder fehlende Funktionen erfassen. Bitte direkt über die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) in Gitea. +- Dokumentation oder Implementierung verbessern. Bitte forke hierzu das Projekt, branche von `main` ab und erstelle dann einen [Pull Request](https://git.wtf-eg.de/kompetenzinventar/ki-backend/pulls). + +### Kommunikation + +Folgende Kanäle gibt es für die Kommunikation über das Kompetenzinventar: + +- Die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-backend/issues) im WTF Gitea. +- Den Bereich [AG Entwicklung](https://forum.wtf-eg.de/c/interna/ag-entwicklung/21) im WTF Forum. +- Einen Raum in Matrix. Zutritt per Einladung, frlan lädt ein, eine einfache PN im Forum reicht. + +### Repos + +* **[ki-backend](https://git.wtf-eg.de/kompetenzinventar/ki-backend)** (dieses Repo) enthält das Backend +* [ki-frontend](https://git.wtf-eg.de/kompetenzinventar/ki-frontend) enthält das Frontend +* Weitere Repositories befinden sich in der Gitea Organisation [Kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar). ## Entwicklung ### Abhängigkeiten