Skip to content

Commit 6f9b6b3

Browse files
committed
docs: expand contributing guide with project overview, tests, PR checklist and release notes
1 parent 993f230 commit 6f9b6b3

1 file changed

Lines changed: 41 additions & 18 deletions

File tree

docs/contributing.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,22 @@
11
# 🤝 Mitwirken an BestNote
22

3-
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.
44

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
620

721
- `main`: stabile Produktionsbasis
822
- `feature/xyz`: neue Features
@@ -11,30 +25,39 @@ Willkommen bei BestNote! Dieses Projekt freut sich über Beiträge von Musikern,
1125

1226
## 🧪 Tests
1327

14-
- Testdateien liegen unter `tests/`
28+
- Teststruktur: `tests/`
29+
- Globale Initialisierung: `tests/setup.ts`
1530
- Direktiven: `tests/directives/`
1631
- 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:
2333

24-
## ✅ PR-Checkliste
25-
Bitte vor dem Pull Request:
34+
```bash
35+
npm run test
36+
npm run test -- --coverage
37+
```
2638

27-
- [ ] Tests laufen lokal (npm run test)
39+
## ✅ PR-Checkliste
2840

41+
- [ ] Tests laufen lokal
2942
- [ ] 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.
3050

31-
- [ ] Dokumentation (README oder docs/) aktualisiert
51+
## 📜 Lizenz
3252

33-
- [ ] Commit-Nachricht ist klar und prägnant
53+
Dieses Projekt steht unter der GPLv3.
3454

35-
## 📘 Weitere Hinweise
36-
Lizenz: GPLv3
55+
---
3756

38-
Sprache: Deutsch & Englisch
57+
### 💾 Commit-Vorschlag
3958

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"
62+
git push
63+
```

0 commit comments

Comments
 (0)