Awesome CursorRules: ein Regelsatz zur Verbesserung der Cursor-KI-Erfahrung

Allgemeine Einführung

awesome-cursorrules ist eine spezialisierte Cursor Cursor AI ist ein KI-gestützter Code-Editor mit .cursorrules-Dateien, die benutzerdefinierte Regeln für die KI bei der Codegenerierung definieren, damit das Verhalten der KI besser auf projektspezifische Anforderungen und Präferenzen abgestimmt ist. Durch die Verwendung von .cursorrules-Dateien können Entwickler sicherstellen, dass der von der KI generierte Code relevanter und genauer ist, was die Produktivität erhöht und die Konsistenz des Codes erhält.

Funktionsliste

• Benutzerdefiniertes KI-Verhalten: Mit .cursorrules-Dateien können Entwickler KI-Reaktionen anpassen, um sie besser an die spezifischen Anforderungen eines Projekts anzupassen.
• Code-Konsistenz: Definieren Sie Coding-Standards und Best Practices, um sicherzustellen, dass der von der KI generierte Code mit dem Style Guide des Projekts übereinstimmt.
• Kontextabhängig: Stellt wichtige Kontextinformationen über das Projekt bereit, z. B. gemeinsame Methoden, architektonische Entscheidungen oder bestimmte Bibliotheken, um die KI bei der Codegenerierung zu unterstützen.
• Steigern Sie die Produktivität: Beschleunigen Sie den Entwicklungsprozess, indem Sie den Bedarf an manueller Bearbeitung durch klar definierte Regeln reduzieren.
• Zusammenarbeit im Team: Bei Teamprojekten sorgen gemeinsame .cursorrules-Dateien dafür, dass alle Mitglieder einheitliche KI-Hilfe erhalten, was die Konsistenz der Kodierungspraktiken fördert.
• Projektspezifisches Wissen: Beinhaltet Informationen über die Projektstruktur, Abhängigkeiten oder besondere Anforderungen, damit die KI genauere und relevantere Empfehlungen geben kann.

Hilfe verwenden

Einbauverfahren

1. Klonen des Projektlagers:

   git clone https://github.com/PatrickJS/awesome-cursorrules.git
   

2. Rufen Sie den Projektkatalog auf:

   cd awesome-cursorrules
   

3. Wählen Sie die entsprechende .cursorrules-Datei entsprechend den Anforderungen Ihres Projekts aus und kopieren Sie sie in das Stammverzeichnis des Projekts.

Verwendung

1. Anpassung des KI-Verhaltens::
   • Erstellen oder bearbeiten Sie die Datei .cursorrules im Stammverzeichnis des Projekts.
   • Definition projektspezifischer Kodierungsstandards und bewährter Verfahren.
   • Stellen Sie Informationen zum Projektkontext bereit, z. B. zu gemeinsamen Methoden, architektonischen Entscheidungen oder bestimmten Bibliotheken.
2. Konsistenz des Codes::
   • Definieren Sie Kodierungsstandards in der .cursorrules-Datei, um sicherzustellen, dass der von AI generierte Code mit dem Styleguide des Projekts übereinstimmt.
   • Fügen Sie Anmerkungen ein, um komplexe Regeln zu erklären oder Kontext zu liefern.
3. kontextabhängig::
   • Stellen Sie wichtige Kontextinformationen über das Projekt bereit, z. B. gemeinsame Methoden, architektonische Entscheidungen oder bestimmte Bibliotheken, um die KI bei der Codegenerierung zu unterstützen.
4. Steigerung der Produktivität::
   • Beschleunigen Sie den Entwicklungsprozess, indem Sie den Bedarf an manueller Bearbeitung durch klar definierte Regeln verringern.
5. Teamarbeit::
   • In Teamprojekten sorgen gemeinsame .cursorrules-Dateien dafür, dass alle Mitglieder konsistente KI-Hilfe erhalten, und fördern einheitliche Kodierungspraktiken.
6. Projektspezifisches Wissen::
   • Fügen Sie Informationen über die Projektstruktur, Abhängigkeiten oder besondere Anforderungen hinzu, damit die KI genauere und relevantere Empfehlungen geben kann.

Detaillierte Vorgehensweise

1. Erstellen einer .cursorrules-Datei::
   • Erstellen Sie im Stammverzeichnis des Projekts eine Datei mit dem Namen .cursorrules des Dokuments.
   • Verwenden Sie das Markdown-Format, um Regeln und Anweisungen zu schreiben.
2. Definitionsregeln::
   • Definieren Sie projektspezifische Kodierungsstandards und bewährte Verfahren in der Datei .cursorrules.
   • Stellen Sie Informationen zum Projektkontext bereit, z. B. zu gemeinsamen Methoden, architektonischen Entscheidungen oder bestimmten Bibliotheken.
3. Anwendungsbeispiel::

   // 项目特定规则
   - 使用 `const` 声明常量，避免使用 `var`。
   - 所有函数必须包含 JSDoc 注释。
   - 使用 `async/await` 处理异步操作，避免使用回调函数。
   

4. Wartung und Aktualisierung::
   • Aktualisieren Sie die .cursorrules-Datei regelmäßig, um sicherzustellen, dass ihr Inhalt mit den Projektanforderungen übereinstimmt.
   • Stellen Sie bei Teamprojekten sicher, dass alle Mitglieder die Regeln in der .cursorrules-Datei verstehen und befolgen.

Wenn Sie diese Schritte befolgen, können Sie die Vorteile der .cursorrules-Datei voll ausschöpfen, um die Codegenerierung von Cursor AI zu verbessern und die Konsistenz und hohe Qualität Ihres Projektcodes zu gewährleisten.