So nutzen Sie den JetBrains AI Assistant für Commit-Nachrichten und Pull-Request-Beschreibungen in IDE-Versionskontroll-Workflows

Das Verfassen präziser Git-Commit-Nachrichten und aussagekräftiger Pull-Request-Beschreibungen (PR) ist entscheidend für saubere, wartbare Repositories. Häufige Kontextwechsel und das manuelle Formulieren dieser Zusammenfassungen unterbrechen jedoch den Entwicklungsfluss. Der JetBrains AI Assistant ist nativ in das Versionskontroll-Toolfenster von IDEs wie IntelliJ IDEA, PyCharm, WebStorm und GoLand integriert. Er ermöglicht es Softwareentwicklern, diff-basierte Commit-Texte automatisch zu generieren, vor dem Commit eine KI-gestützte Selbstprüfung durchzuführen und strukturierte PR-Beschreibungen direkt im Editor zu erstellen.

Diese Anleitung erklärt Schritt für Schritt, wie Sie den JetBrains AI Assistant in Git-Workflows einrichten, Prompts an Teamstandards anpassen und ergänzende Funktionen wie Konfliktlösung und Code-Review-Zusammenfassungen nutzen.

Voraussetzungen und Einrichtung

Bevor Sie KI-Funktionen für die Versionskontrolle verwenden, stellen Sie sicher, dass Ihre Umgebung folgende Anforderungen erfüllt:

1. Kompatible JetBrains-IDE: Version 2024.1 oder neuer (z. B. IntelliJ IDEA, PyCharm, WebStorm, GoLand, CLion oder Rider).
2. AI Assistant Plugin & Gültiges Abonnement:
   • Das Plugin JetBrains AI Assistant muss unter Settings | Plugins (Strg+Alt+S unter Windows/Linux, Cmd+, unter macOS) aktiviert sein.
   • Sie müssen mit einem JetBrains Account angemeldet sein, der über ein aktives Kontingent verfügt (AI Free Testkontingent, AI Pro, AI Ultimate oder eine über JetBrains Central zugewiesene Unternehmenslizenz).
3. Aktivierte Versionskontroll-Plugins:
   • Ein mit Git oder Mercurial initialisiertes Projekt.
   • Die integrierten Git- und GitHub- (oder GitLab-)Plugins müssen aktiviert sein, um das Toolfenster für Pull Requests nutzen zu können.

1. Commit-Nachrichten mit dem AI Assistant generieren

Der JetBrains AI Assistant analysiert die Code-Änderungen (Diffs) im Staging-Bereich oder in ausgewählten Changelists und formuliert eine prägnante Zusammenfassung von Zweck und technischer Umsetzung.

Schritt-für-Schritt-Anleitung

1. Commit-Toolfenster öffnen:
   • Drücken Sie Alt+0 unter Windows/Linux bzw. Cmd+0 unter macOS (oder nutzen Sie Strg+K / Cmd+K).
2. Zu committende Änderungen auswählen:
   • Markieren Sie die gewünschten Dateien, Code-Blöcke (Chunks) oder Changelists. Der AI Assistant analysiert ausschließlich die ausgewählten Diffs, wodurch sich atomare Teil-Commits (Partial Commits) exakt abbilden lassen.
3. KI-Generierung auslösen:
   • Klicken Sie oberhalb des Commit-Nachrichtenfelds auf das Symbol Generate Commit Message with AI Assistant (Zauberstab-/Funken-Symbol).
4. Ergebnis prüfen und verfeinern:
   • Der Assistent fügt eine prägnante Betreffzeile gefolgt von stichpunktartigen Erläuterungen ein.
   • Ergänzen Sie bei Bedarf Ticket-IDs (z. B. PROJ-1024) oder Hinweise auf Breaking Changes und bestätigen Sie den Commit (Strg+Enter oder Cmd+Enter).

Add JWT authentication middleware and token expiration check

- Introduce AuthTokenValidator class to verify bearer tokens
- Register authentication interceptor in security configuration
- Add unit test coverage for expired and malformed tokens

2. Commit-Standards und Prompt-Vorlagen anpassen

Entwicklungsteams nutzen oft verbindliche Richtlinien wie Conventional Commits (feat:, fix:, refactor:), Begrenzungen der Zeichenanzahl oder zwingende Branch-Referenzen. JetBrains bietet zwei Möglichkeiten zur Anpassung:

Methode A: Schnellanpassung im Commit-Fenster

1. Klicken Sie auf das Zahnrad-Symbol (Settings) in der unteren rechten Ecke des Commit-Fensters.
2. Geben Sie im Abschnitt AI Assistant Ihre Anweisungen in das Feld Prompt for generation ein.
3. Nutzen Sie die integrierte Variable $GIT_BRANCH_NAME, um den aktuellen Branch-Namen dynamisch einzubinden (z. B.: Extrahiere die Ticket-Nummer aus $GIT_BRANCH_NAME und stelle sie als Präfix voran).

Methode B: Globale Richtlinien in der Prompt Library

1. Öffnen Sie Settings | Tools | AI Assistant | Prompt Library (Strg+Alt+S oder Cmd+,).
2. Wählen Sie unter Built-In Actions den Eintrag Commit Message Generation.
3. Definieren Sie die Regeln im rechten Editorbereich:
   • Namenskonvention: „Halte dich strikt an die Conventional-Commits-Spezifikation.“
   • Zeilenlänge: „Begrenze die Titelzeile auf maximal 50 Zeichen und formatiere Beschreibungstexte mit einem Zeilenumbruch nach 72 Zeichen.“
   • Sprache: Stellen Sie Deutsch oder Englisch als Ausgabesprache ein.
4. Klicken Sie auf Apply. Alle zukünftigen Generationen folgen dieser Konfiguration.

3. Vorab-Selbstprüfung mit KI (Self-Review with AI)

Um zu verhindern, dass versehentlich Debug-Ausgaben, Passwörter oder logische Flüchtigkeitsfehler im Repository landen, bietet der AI Assistant eine integrierte Vorabprüfung:

1. Wählen Sie im Commit-Fenster die vorbereiteten Änderungen aus.
2. Klicken Sie auf Self-Review with AI.
3. Das Fenster Problems öffnet sich auf dem Reiter AI Self-Review und listet mögliche Schwachstellen auf:
   • Vergessene Debugging-Befehle (wie console.log oder System.out.println).
   • Null-Pointer-Risiken, unbehandelte Randfälle und potenzielle Ressourcenlecks.
   • Inkonsistenzen bei Namensgebung und Formatierung.
4. Per Doppelklick oder mit F4 springen Sie direkt zur Quellcodezeile und können IDE-Quick-Fixes anwenden.
5. In Settings | Tools | AI Assistant | Project Settings können Teams unter Path to rules for AI Self-Review eine unternehmenseigene Markdown-Richtlinie hinterlegen.

4. Bestehende lokale Commits bearbeiten und verbessern

Haben Sie Änderungen lokal committet, aber noch nicht gepusht, und möchten die Nachricht verfeinern:

1. Öffnen Sie das Git-Log-Fenster mit Alt+9 unter Windows/Linux bzw. Cmd+9 unter macOS.
2. Klicken Sie mit der rechten Maustaste auf den Commit und wählen Sie Edit Commit Message.
3. Klicken Sie im Dialog auf Improve Commit Message with AI Assistant.
4. Die KI analysiert den Diff des Commits erneut und liefert eine überarbeitete Beschreibung. Bestätigen Sie mit OK und pushen Sie den Branch (Strg+Umschalt+K bzw. Cmd+Shift+K).

5. Pull-Request- und Merge-Request-Beschreibungen generieren

Beim Übergang von der lokalen Entwicklung zum Code-Review im Team beschleunigen gut gegliederte PR-Beschreibungen die Freigabe erheblich.

PR-Erstellung direkt in der IDE

1. Pull-Requests-Fenster öffnen:
   • Wählen Sie im Hauptmenü Git | GitHub | View Pull Requests (oder GitLab | View Merge Requests).
2. Neuen PR anlegen:
   • Klicken Sie auf das +-Symbol und wählen Sie Basis- und Feature-Branch aus.
3. Titel und Beschreibung per Klick erzeugen:
   • Klicken Sie im Beschreibungsfeld auf Generate a Title and Description with AI Assistant.
   • Die KI analysiert sämtliche Commits und Dateiunterschiede des Branches und erstellt einen strukturierten Markdown-Entwurf:
     • Zusammenfassung (Summary): Überblick über das gelöste Problem oder die neue Funktion.
     • Wesentliche Änderungen (Key Changes): Modulweise Aufzählung der Anpassungen.
     • Verifizierung (Verification): Empfohlene Testschritte zur Abnahme.
4. Ergänzen und Veröffentlichen:
   • Fügen Sie Reviewer oder Ticket-Links hinzu und klicken Sie auf Create Pull Request.

Eingehende PRs automatisch zusammenfassen

Beim Prüfen von PRs anderer Teammitglieder hilft die automatische Zusammenfassung:

• Aktivieren Sie unter Settings | Tools | AI Assistant | Features die Option GitHub Plugin: Generate a summary upon opening a Pull Request.
• Beim Öffnen eines PRs wird direkt eine Zusammenfassung angezeigt. Detailgrad (Verbosity) und Tonalität können in den Einstellungen angepasst werden.

Best Practices für Entwickler

Die Integration des JetBrains AI Assistant in tägliche Versionskontrollabläufe entlastet Entwickler von repetitiven Formulierungsaufgaben und sorgt für eine transparente, standardisierte Projekt- und Revisionshistorie.

Referenzen

• AI in version control | AI Assistant Documentation
• Create and Understand Commit Messages with AI Assistant - JetBrains Guide
• Commit and push changes to Git repository | IntelliJ IDEA Documentation
• Review incoming GitHub pull requests | IntelliJ IDEA Documentation
• AI Assistant in JetBrains IDEs - The JetBrains Blog