tools - Improve readme, contributing, templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -9,16 +9,16 @@ assignees: ''
 **Mods (vollständig und mit den folgenden Information):**
 
 - **Arma 3:** `x.xx` [z.B. 1.00 stable, rc,  dev]
-- **CBA:** `3.x.x` [z.B. 3.0.0 stable, commit hash]
-- **ACE3:** `3.x.x` [z.B. 3.0.0 stable, commit hash]
-- **TTT-Mod:** `3.x.x` [z.B. 3.0.0]
+- ***TTT-Modset:** `Kompakt vom TT.MM.JJ` [z.B. Kompakt, CUP, RHS, Event mit Datum]
 
 **Beschreibung:**
 
 Eine kurze und präzise Beschreibung was der Fehler ist.
 
 **Schritte zum Reproduzieren:**
 
+Beschreibe was getan werden muss, um den Fehler zu bekommen:
+
 1. _Gehe zu ..._
 2. _Klicke ..._
 3. _Du siehst, dass ..._

.github/ISSUE_TEMPLATE/feature_request.md

@@ -6,17 +6,17 @@ labels: 'feature request'
 assignees: ''
 ---
 
-**Wie lautet dein Vorschlag für ein neues Feature? Hat er etwas mit einem Problem zu tun?**
+**Wie lautet dein Vorschlag für ein neues Feature? Hat es etwas mit einem Problem zu tun?**
 
-Eine klare und kurze Beschreibung, was dein Verbesserungsvorschlag ist.
+Schreibe hier eine klare und kurze Beschreibung, was dein Verbesserungsvorschlag ist.
 
-**Beschreibe die Lösung, die du dir vorstellst**
+**Beschreibe die Lösung, die du dir vorstellst:**
 
-Eine klare und kurze Beschreibung, was du gerne als Lösung sehen würdest.
+Schreibe hier eine klare und kurze Beschreibung, was du gerne als Lösung sehen würdest.
 
-**Beschreibe Alternativen, die du in Betracht gezogen hast**
+**Beschreibe Alternativen, die du in Betracht gezogen hast:**
 
-Eine klare und kurze Beschreibung welche Alternativen du in Betracht gezogen hast - und warum diese nicht ausreichend sind.
+Eine klare und kurze Beschreibung welche Alternativen du in Betracht gezogen hast - und ggf. warum diese nicht ausreichend sind.
 
 **Zusätzliche Informationen:**
 

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,3 +10,4 @@
 
 - [Development Guidelines](https://ace3.acemod.org/wiki/development/) are read, understood and applied.
 - Title of this PR uses our standard template `Component - Add|Fix|Improve|Change|Remove {changes}`.
+- Component folder has a README.md explaining the component.

.github/workflows/main.yml

@@ -22,18 +22,13 @@ jobs:
       - name: Check for BOM
         uses: arma-actions/bom-check@master
 
-  build:
+  check:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@master
         with:
           fetch-depth: 0
       - name: Setup HEMTT
         uses: arma-actions/hemtt@v1
-      - name: Run HEMTT build
-        run: hemtt release
-      - name: Upload Release
-        uses: actions/upload-artifact@v4
-        with:
-          name: "@ttt_a3"
-          path: ".hemttout/release/*"
+      - name: Run HEMTT check
+        run: hemtt check

CONTRIBUTING

@@ -0,0 +1,26 @@
+# Zum Projekt beitragen
+
+Wir heißen jeden willkommen, der zu diesem Repository beiträgt. Themen, für die wir aktiv Hilfe suchen, sind als [„Hilfe gesucht“](https://github.com/TacticalTrainingTeam/ttt_a3/issues?q=is%3Aissue+state%3Aopen+label%3A%22hilfe+gesucht%22) gekennzeichnet.
+
+## Pull Request Prozess
+
+Wenn Du zu diesem Projekt beitragen möchtest, bespreche bitte zuerst die Änderung, die du vornehmen möchtest, per [Issue](https://github.com/TacticalTrainingTeam/ttt_a3/issues) oder [Discord](https://discord.tacticalteam.de/) mit den TTT-Mod-Projektbetreuern, bevor du eine Änderung vornimmst. Dies ist nicht unbedingt notwendig, wenn du etwas beitragen möchtest, für das es bereits ein Issue in unserem Repository gibt.
+
+1. Bitte erstelle deinen [Pull Request](https://github.com/TacticalTrainingTeam/ttt_a3/pulls) (PR) so früh wie möglich. Dies ermöglicht es uns, dir bei der Entwicklung zu helfen. Wenn du einen Pull-Request eröffnest, verwende ggf. die Draft-Funktion von GitHub. Dadurch wird der PR als in Arbeit markiert und kann nicht zusammengeführt werden, bis du ihn als reif für die Überprüfung markiers.
+
+2. Beschreibe in der Beschreibung deines PRs, was dieser Pull Request tun wird und wie er das Problem löst. Eine klare Absicht und Beschreibung der Art und Weise, wie das Problem gelöst wird, wird uns helfen, den PR effizienter zu prüfen.
+
+3. Bitte beachte die [Entwicklungsrichtlinien von (ACE3)](https://ace3.acemod.org/wiki/development/coding-guidelines).
+
+### Pull Request Merging
+
+- Jeder Pull Request muss das [CI](https://github.com/TacticalTrainingTeam/ttt_a3/actions) ohne Fehler durchlaufen bevor er gemergt werden kann.
+- Jeder Pull Request muss von mindestens einem Reviewer freigegeben werden bevor er gemergt wird.
+
+## Anmerkungen
+
+Bitte beachte, dass alle Mitwirkenden an diesem Projekt Freiwillige sind und dies in ihrer eigenen Zeit tun. Das bedeutet, dass Probleme und/oder PRs lange Zeit offen sein können, bevor sie aufgegriffen und überprüft werden. Wir versuchen, diese Zeit so kurz wie möglich zu halten, aber manchmal kann es vorkommen, dass dies nicht gelingt. Wenn du der Meinung sind, dass ein Problem oder eine PR nicht beachtet wurde, teilen Sie dies bitte im Discord mit.
+
+Im Code wird Tactical Training Team immer klein geschrieben, also `ttt`, im Interface immer groß `TTT`.
+
+Als `author` wird in der `config.cpp` aus konsistenzgründen immer `ECSTRING(main,TactiaclTrainingTeam)` angegeben. In `authors[]`-Array können sich alle, die an der jeweiligen Component mitgearbeitet haben selbst eintragen.

readme.md

@@ -1,6 +1,8 @@
 # TTT Mod
 
-Arma 3 Modifikation für das Tactical Training Team.
+[![CI](https://github.com/TacticalTrainingTeam/ttt_a3/actions/workflows/main.yml/badge.svg?branch=master)](https://github.com/TacticalTrainingTeam/ttt_a3/actions/workflows/main.yml)
+
+Arma 3 Modifikation für das Tactical Training Team. Benötigt die aktuellste version von [CBA A3](https://github.com/CBATeam/CBA_A3/releases) und [ACE](https://github.com/acemod/ACE3/releases).
 
 Du willst mitmachen? <http://www.tacticalteam.de/mitmachen>
 
@@ -9,26 +11,16 @@ Du willst mitmachen? <http://www.tacticalteam.de/mitmachen>
 1. Visual Studio Code installieren - <https://code.visualstudio.com>
     - hemtt Extension installieren - <https://marketplace.visualstudio.com/items?itemName=brettmayson.hemtt>
 2. Arma 3 Tools über Steam installieren und einmal starten
-3. hemtt installieren `winget install hemtt` in einer Kommandozeile ausführen - Dokumentation: <https://hemtt.dev>
-4. das Repo Clonen `git clone https://github.com/TacticalTrainingTeam/ttt_a3.git` in der Kommandozeile ausführen
+3. `hemtt` installieren - `winget install hemtt` in der Kommandozeile ausführen
+   - Dokumentation: <https://hemtt.dev>
+4. das Repo Clonen - `git clone https://github.com/TacticalTrainingTeam/ttt_a3.git` in der Kommandozeile ausführen
 5. Folgende Mods im Steamworkshop abonnieren:
     - CBA <https://steamcommunity.com/workshop/filedetails/?id=450814997>
     - ACE <https://steamcommunity.com/sharedfiles/filedetails/?id=463939057>
     - ACRE <https://steamcommunity.com/sharedfiles/filedetails/?id=751965892>
     - Advanced Developer Tools <https://steamcommunity.com/sharedfiles/filedetails/?id=2369477168>
     - 3DEN Attributes Fast Load <https://steamcommunity.com/sharedfiles/filedetails/?id=3023395342>
     - ZEN <https://steamcommunity.com/sharedfiles/filedetails/?id=1779063631>
-6. In der Kommandozeile `hemtt launch` um Arma 3 mit dem Basismods zu starten
-
-Für CUP, RHS, BWmod etc. sind zum Testen weitere Mods erforderlich, diese sind in der `launch.toml` angeben.
-
-## Guidelines
-
-Wir versuchen den ACE Coding Guidelines zu folgen: <https://ace3.acemod.org/wiki/development/coding-guidelines>
-
-Im Code wird Tactical Training Team immer klein geschrieben, also 'ttt', im Interface immer groß 'TTT'.
-
-## Pull Request Merging
+6. In der Kommandozeile `hemtt launch` ausführen, um Arma 3 mit dem Basismods zu starten
 
-- Jeder Pull Request muss das CI ohne Fehler durchlaufen.
-- Jeder Pull Request muss von einem Reviewer bestätigt werden bevor er gemergt wird.
+Für CUP, RHS, BWmod etc. sind zum Testen weitere Mods erforderlich, diese sind in der `.hemtt/launch.toml` angeben.