|
2 | 2 |
|
3 | 3 | **Copyright (c) 2025 SunnyCueq** |
4 | 4 |
|
5 | | -Diese Datei wird automatisch von Cursor gelesen und als Kontext für AI-Assistenten verwendet. |
| 5 | +## ⚠️ WICHTIG: Lies IMMER RULES.md |
6 | 6 |
|
7 | | -## ⚠️ KRITISCH: RULES.md IMMER berücksichtigen |
| 7 | +**Diese Datei enthält NUR einen Verweis. Alle Regeln sind in `RULES.md` dokumentiert!** |
8 | 8 |
|
9 | | -**IMMER die folgenden Dateien im Root-Verzeichnis beachten:** |
10 | | -- `RULES.md` - Vollständige Projekt-Regeln (INTERN, nicht auf GitHub) - **DIESE DATEI ENTHÄLT ALLE REGELN!** |
11 | | -- `PROJEKT-STATUS.md` - Projekt-Status und Kontext (INTERN, nicht auf GitHub) |
| 9 | +### Vor jeder Aktion: |
12 | 10 |
|
13 | | -**WICHTIG:** `.cursorrules` enthält eine Kurzfassung der Regeln aus `RULES.md`. Bei Unklarheit IMMER `RULES.md` konsultieren! |
| 11 | +1. **IMMER** `RULES.md` lesen (vollständige Regeln im Root-Verzeichnis) |
| 12 | +2. **IMMER** `PROJEKT-STATUS.md` prüfen (aktueller Projekt-Status) |
| 13 | +3. Bei Unklarheit: **NIEMALS** raten, sondern `RULES.md` konsultieren |
14 | 14 |
|
15 | | -**ALLE MD-Dateien aktuell halten:** |
16 | | -- Bei Änderungen IMMER alle betroffenen MD-Dateien aktualisieren |
17 | | -- README.md und README_EN.md synchron halten |
18 | | -- Dokumentation in `docs/` aktuell halten |
19 | | -- Interne Dokumentation (RULES.md, etc.) bei neuen Regeln aktualisieren |
| 15 | +### Wichtige Dateien (alle im Root): |
20 | 16 |
|
21 | | ---- |
22 | | - |
23 | | -## Kernregeln (aus RULES.md) |
24 | | - |
25 | | -### 1. Ansprache: Per-Du |
26 | | -- ✅ **IMMER** "Du" verwenden, nie "Sie" |
27 | | -- ✅ Persönlich und freundlich bleiben |
28 | | -- ✅ Beispiel: "Du kannst..." statt "Sie können..." |
29 | | - |
30 | | -### 2. Einfachheit ist oberstes Gebot |
31 | | -- ✅ Alles muss für Laien verständlich sein |
32 | | -- ✅ Schritt-für-Schritt Anleitungen |
33 | | -- ✅ Jeden Schritt genau erklären |
34 | | -- ✅ Keine Annahmen über Vorwissen |
35 | | -- ✅ Alternative Wege anbieten wenn etwas nicht funktioniert |
36 | | - |
37 | | -### 3. Terminal-Anleitungen |
38 | | -- ✅ **IMMER** erklären, wo das Terminal geöffnet wird: |
39 | | - - Im System selbst (Finder, Datei-Explorer, etc.) |
40 | | - - In der IDE (integriertes Terminal) |
41 | | - - Alternative Wege |
42 | | -- ✅ Screenshots oder klare Beschreibungen |
43 | | -- ✅ Was passiert wenn der Befehl nicht funktioniert |
44 | | - |
45 | | -### 4. Download-Links |
46 | | -- ✅ **IMMER** Download-Links zu IDEs anbieten: |
47 | | - - Cursor: https://cursor.sh/ |
48 | | - - VSCode: https://code.visualstudio.com/ |
49 | | - - Git: https://git-scm.com/ |
50 | | -- ✅ Am Anfang der Dokumentation, nicht versteckt |
51 | | - |
52 | | -### 5. Mehrsprachigkeit |
53 | | -- ✅ Deutsch (DE) und Englisch (EN) für alle Standard-Dokumentationen |
54 | | -- ✅ Advanced-Dokumentation bleibt Englisch und fachlich |
55 | | -- ✅ Konsistenz zwischen DE und EN Versionen |
56 | | - |
57 | | -### 6. Redundanz vermeiden |
58 | | -- ✅ Keine doppelten Informationen |
59 | | -- ✅ Verweise auf andere Dokumentationen statt Wiederholung |
60 | | -- ✅ Klare Struktur ohne Überschneidungen |
61 | | -- ✅ **KEINE WoltLab-Dokumentation wiederholen** - Verweise auf offizielle Docs |
62 | | - |
63 | | -### 7. Fehler und Syntax |
64 | | -- ✅ Alle Code-Beispiele testen |
65 | | -- ✅ Korrekte Syntax prüfen |
66 | | -- ✅ Keine Tippfehler |
67 | | -- ✅ Konsistente Formatierung |
68 | | - |
69 | | -### 8. Alternative Wege |
70 | | -- ✅ **IMMER** alternative Lösungen anbieten |
71 | | -- ✅ Was tun wenn etwas nicht funktioniert |
72 | | -- ✅ Troubleshooting direkt einbauen |
73 | | -- ✅ Beispiel: "Falls das nicht funktioniert, versuche..." |
74 | | - |
75 | | -### 9. Mac-Unterstützung |
76 | | -- ✅ Mac-Anleitungen für alle wichtigen Schritte |
77 | | -- ✅ Homebrew-Befehle |
78 | | -- ✅ macOS-spezifische Pfade |
79 | | -- ✅ Separate Mac-Dokumentation (DE/EN) |
80 | | - |
81 | | -### 10. Copyright |
82 | | -- ✅ Copyright-Hinweis in ALLEN Dateien |
83 | | -- ✅ Format: "Copyright (c) 2025 SunnyCueq" |
84 | | -- ✅ Hinweis dass Copyright nicht entfernt werden darf |
85 | | -- ✅ MIT-Lizenz erwähnen |
86 | | - |
87 | | -### 11. Dateien die NICHT auf GitHub gehören |
88 | | -- ✅ RULES.md (diese Datei) |
89 | | -- ✅ PROJEKT-KONTEXT.md |
90 | | -- ✅ GITHUB_SETUP.md |
91 | | -- ✅ GITHUB_REPO_INFO.md |
92 | | -- ✅ GITHUB-WORKFLOW-ERKLAERUNG.md |
93 | | -- ✅ WSPACKAGER-ANALYSE.md |
94 | | -- ✅ FINALE-PRUEFUNG-ABGESCHLOSSEN.md |
95 | | -- ✅ ANALYSE-ALLE-DATEIEN.md |
96 | | -- ✅ docs/GITHUB-WORKFLOW-TEST.md |
97 | | -- ✅ docs/WSPACKAGER-ANALYSE.md |
98 | | -- ✅ Alle in .gitignore aufgenommen |
99 | | -- ✅ **IMMER prüfen:** Neue interne Dateien sofort zu .gitignore hinzufügen |
100 | | - |
101 | | -### 12. Versionsverwaltung |
102 | | -- ✅ Semantic Versioning (MAJOR.MINOR.PATCH) |
103 | | -- ✅ WoltLab-konformes Schema |
104 | | -- ✅ Automatische Versionsverwaltung für Plugins |
105 | | -- ✅ Backup-Funktionalität |
106 | | - |
107 | | -### 13. Entwickler-Werkzeuge |
108 | | -- ✅ Entwickler-Optionen dokumentieren |
109 | | -- ✅ Debug-Modus, Benchmark, etc. |
110 | | -- ✅ Sicherheitshinweise |
111 | | -- ✅ Workflow für Plugin-Entwicklung |
| 17 | +- **`RULES.md`** - Vollständige Projekt-Regeln (QUELLE DER WAHRHEIT) |
| 18 | +- **`PROJEKT-STATUS.md`** - Projekt-Status und Kontext |
| 19 | +- **`.cursorrules`** - Diese Datei (nur Verweis) |
112 | 20 |
|
113 | | -### 14. Plugin-Namenskonventionen |
114 | | -- ✅ Format: com.[domain].[pluginname] |
115 | | -- ✅ Beispiele und Erklärungen |
116 | | -- ✅ DO's und DON'Ts |
| 21 | +### Kernregeln (aus RULES.md): |
117 | 22 |
|
118 | | -### 15. Datei-Organisation |
119 | | -- ✅ **README.md, README_EN.md, LICENSE, install.sh** bleiben im Root |
120 | | -- ✅ **Alle anderen MD-Dateien** gehören in `docs/` (außer interne, die in .gitignore sind) |
121 | | -- ✅ README_ADVANCED.md gehört in `docs/` |
122 | | -- ✅ Keine unnötigen Dateien im Root |
123 | | - |
124 | | -### 16. Git-Commits und AI-Tool-Referenzen |
125 | | -- ✅ **NIEMALS** Claude, Cursor oder andere AI-Tools in öffentlichen Commits erwähnen |
126 | | -- ✅ **NIEMALS** "Generated with Claude Code" oder ähnliche Signaturen |
127 | | -- ✅ **NIEMALS** "Co-Authored-By: Claude" oder ähnliches |
128 | | -- ✅ **NUR** SunnyCueq als Author in allen Commits |
129 | | -- ✅ Commit-Messages professionell und neutral formulieren |
130 | | - |
131 | | ---- |
132 | | - |
133 | | -## Versionsverwaltung und Releases |
134 | | - |
135 | | -### Commits und Pushes |
136 | | -- ✅ **IMMER** nach jeder Änderung committen und pushen |
137 | | -- ✅ Versionsverwaltung beachten (siehe unten) |
138 | | -- ✅ Klare Commit-Messages verwenden |
139 | | -- ✅ Regelmäßig pushen (nicht alles auf einmal) |
140 | | - |
141 | | -### Versionsverwaltung |
142 | | -- ✅ **IMMER** Version erhöhen bei Änderungen |
143 | | -- ✅ Semantic Versioning verwenden (MAJOR.MINOR.PATCH) |
144 | | -- ✅ Git-Tag erstellen nach Version-Update |
145 | | -- ✅ Tag pushen: `git push origin vX.Y.Z` |
146 | | -- ✅ **IMMER ein GitHub Release erstellen** (wichtig!) |
147 | | - |
148 | | -### Release-Verwaltung |
149 | | -- ✅ **IMMER** nach Version-Update ein GitHub Release erstellen |
150 | | -- ✅ **IMMER** bei jeder neuen Version ein Release anbieten |
151 | | -- ✅ Release-Notes mit Changelog hinzufügen |
152 | | -- ✅ Package-Dateien als Assets hochladen (falls vorhanden) |
153 | | -- ✅ Release auf GitHub veröffentlichen, nicht nur als Draft |
154 | | -- ✅ Release sollte automatisch erstellt werden (GitHub Actions oder manuell) |
155 | | - |
156 | | -### Backup-Versionen |
157 | | -- ✅ **IMMER** die zwei letzten Versionen behalten: |
158 | | - - **Aktuelle Version** (z.B. 1.0.1) → **Als Release anbieten** |
159 | | - - **Vorherige Version** (z.B. 1.0.0) → **Als Backup behalten** |
160 | | -- ✅ Ältere Versionen können archiviert werden |
161 | | -- ✅ Backups in `.package-backups/` für Plugins |
162 | | -- ✅ **System:** Aktuelle Version = Release, Version davor = Backup |
| 23 | +- ✅ **Per-Du** anstatt "Sie" |
| 24 | +- ✅ **Einfachheit** für Laien |
| 25 | +- ✅ **Keine AI-Tool-Referenzen** in öffentlichen Commits |
| 26 | +- ✅ **IMMER** RULES.md als erste Quelle |
163 | 27 |
|
164 | 28 | --- |
165 | 29 |
|
166 | | -## Checkliste vor jedem Commit |
167 | | - |
168 | | -- [ ] Alle "Sie" durch "Du" ersetzt? |
169 | | -- [ ] Terminal-Anleitungen erklärt wo Terminal geöffnet wird? |
170 | | -- [ ] Download-Links zu IDEs vorhanden? |
171 | | -- [ ] Alternative Wege angeboten? |
172 | | -- [ ] Mac-Unterstützung berücksichtigt? |
173 | | -- [ ] Redundanzen entfernt? |
174 | | -- [ ] Fehler und Syntax geprüft? |
175 | | -- [ ] Copyright-Hinweis vorhanden? |
176 | | -- [ ] Einfach genug für Laien? |
177 | | -- [ ] Mehrsprachigkeit beachtet (DE/EN)? |
178 | | -- [ ] Version erhöht (falls nötig)? |
179 | | -- [ ] Git-Tag erstellt und gepusht? |
180 | | -- [ ] GitHub Release erstellt? |
181 | | -- [ ] Backup-System funktioniert (2 Versionen)? |
182 | | -- [ ] Neue interne Dateien zu .gitignore hinzugefügt? |
183 | | -- [ ] RULES.md aktualisiert (falls neue Regeln)? |
184 | | -- [ ] .cursorrules aktualisiert (falls neue Regeln)? |
185 | | - |
186 | | ---- |
187 | | - |
188 | | -## Wichtige Erinnerungen |
189 | | - |
190 | | -- RULES.md ist die vollständige Quelle - IMMER dort nachschauen |
191 | | -- Bei neuen Regeln: RULES.md UND .cursorrules aktualisieren |
192 | | -- Changelog bleibt lokal, nicht auf GitHub in README |
193 | | -- Bei neuen Versionen: IMMER GitHub Release erstellen |
194 | | -- Bei neuen Dateien: Prüfen ob sie auf GitHub gehören |
195 | | - |
196 | | ---- |
| 30 | +**Letzte Aktualisierung:** 2025-11-08 |
197 | 31 |
|
198 | | -**Letzte Aktualisierung:** 2025-01-08 |
| 32 | +**WICHTIG:** Für alle Details siehe `RULES.md` im Root-Verzeichnis! |
0 commit comments