You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Willkommen bei BestNote! Dieses Projekt freut sich über Beiträge von Musikern, Entwicklern und Open-Source-Enthusiasten.
3
+
Willkommen bei BestNote – einem KI-gestützten Noten- und Kalenderverwaltungssystem für Musikvereine. Dieses Projekt freut sich über Beiträge von Musiker:innen, Entwickler:innen und Open-Source-Enthusiast:innen.
4
4
5
-
## 🧭 Branch-Konventionen
5
+
## 🧭 Projektüberblick
6
+
7
+
- Modularer Aufbau (Directives, Services, Stores)
8
+
- Rollenbasierte Berechtigungen
9
+
- Mehrsprachige Dokumentation
10
+
- Vollständig testbar mit Vitest
11
+
12
+
## 🛠 Mitwirkungsregeln
13
+
14
+
- Bitte respektiere die Branch-Konventionen
15
+
- Schreibe klare Commits (`type(scope): message`)
16
+
- Dokumentiere neue Features in `README` oder `docs/`
17
+
- Teste neue Funktionen mit Vitest
18
+
19
+
## 🌿 Branch-Konventionen
6
20
7
21
-`main`: stabile Produktionsbasis
8
22
-`feature/xyz`: neue Features
@@ -11,30 +25,39 @@ Willkommen bei BestNote! Dieses Projekt freut sich über Beiträge von Musikern,
11
25
12
26
## 🧪 Tests
13
27
14
-
- Testdateien liegen unter `tests/`
28
+
- Teststruktur: `tests/`
29
+
- Globale Initialisierung: `tests/setup.ts`
15
30
- Direktiven: `tests/directives/`
16
31
- Services: `tests/services/`
17
-
- Globale Testinitialisierung: `tests/setup.ts` mit `createTestingPinia()`
18
-
- Tests ausführen:
19
-
```bash
20
-
npm run test
21
-
npm run test -- --coverage
22
-
```
32
+
- Testausführung:
23
33
24
-
## ✅ PR-Checkliste
25
-
Bitte vor dem Pull Request:
34
+
```bash
35
+
npm run test
36
+
npm run test -- --coverage
37
+
```
26
38
27
-
-[ ] Tests laufen lokal (npm run test)
39
+
## ✅ PR-Checkliste
28
40
41
+
-[ ] Tests laufen lokal
29
42
-[ ] Neue Funktionen sind getestet
43
+
-[ ] Dokumentation aktualisiert
44
+
-[ ] Commit-Nachricht ist klar
45
+
-[ ] Branch-Konvention eingehalten
46
+
47
+
## � Release-Hinweise
48
+
49
+
Bitte beachte `RELEASE.md` für alle Schritte zur Veröffentlichung.
30
50
31
-
-[ ] Dokumentation (README oder docs/) aktualisiert
51
+
## 📜 Lizenz
32
52
33
-
-[ ] Commit-Nachricht ist klar und prägnant
53
+
Dieses Projekt steht unter der GPLv3.
34
54
35
-
## 📘 Weitere Hinweise
36
-
Lizenz: GPLv3
55
+
---
37
56
38
-
Sprache: Deutsch & Englisch
57
+
### 💾 Commit-Vorschlag
39
58
40
-
Doku: siehe README.de.md und README.en.md
59
+
```bash
60
+
git add docs/contributing.md
61
+
git commit -m "docs: finalize contributing guide with onboarding and PR checklist"
0 commit comments