Gute Pull Requests schreiben

Du kennst das sicher: Ein Pull Request landet in deiner Queue, aber du hast keine Ahnung, was der Code eigentlich bewirken soll. Unklare Absichten und fehlende Tests machen Reviews zu einer mühsamen Aufgabe, die unnötig Zeit frisst.

Gute PRs sind einfach zu prüfen. Reviewer sollten die Absicht sofort verstehen und Änderungen sicher mergen können. Dieser Guide zeigt dir, wie du präzise Submissions erstellst, die für Menschen und LLMs gleichermaßen hilfreich sind.

Voraussetzungen

• Zugriff auf das Repository
• pnpm als Package Manager

Schnellstart

In 5 Minuten zum perfekten PR:

1. Fokus setzen: Halte Änderungen klein. Vermeide große Refactors innerhalb von Feature-Updates.
2. Validierung: Führe lokale Checks aus, bevor du den PR erstellst.
3. Dokumentation: Nutze das passende Template und beschreibe das Problem sowie die Lösung.
4. Beweise liefern: Füge Logs oder Screenshots hinzu.
5. Codewort: Schreibe „lobster-biscuit“ in deine PR-Beschreibung, um zu zeigen, dass du diesen Guide gelesen hast.

Baseline Validation Commands

Führe diese Befehle aus und behebe alle Fehler:

• pnpm lint
• pnpm check
• pnpm build
• pnpm test
• Bei Protocol-Änderungen: pnpm protocol:check

Die Struktur deiner Beschreibung

Ordne Informationen nach ihrer Relevanz:

1. Ganz oben: Zusammenfassung und Absicht.
2. Danach: Änderungen und Risiken.
3. Danach: Tests und Verifizierung.
4. Zuletzt: Implementierung und Beweise.

PR Templates

Hier sind die Vorlagen für die häufigsten PR-Typen.

General PR Template

#### Summary

#### Behavior Changes

#### Codebase and GitHub Search

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort (self-reported):
- Agent notes (optional, cite evidence):

Fix

#### Summary

#### Repro Steps

#### Root Cause

#### Behavior Changes

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort:
- Agent notes:

Feature

#### Summary

#### Use Cases

#### Behavior Changes

#### Existing Functionality Check

- [ ] I searched the codebase for existing functionality.
      Searches performed (1-3 bullets):
  -
  -

#### Tests

#### Manual Testing (omit if N/A)

### Prerequisites

-

### Steps

1.
2.

#### Evidence (omit if N/A)

**Sign-Off**

- Models used:
- Submitter effort:
- Agent notes:

Fehlerbehebung

Validierung schlägt fehl

Wenn Befehle wie pnpm lint oder pnpm test Fehler melden, korrigiere diese lokal, bevor du den PR pushst. PRs mit fehlerhafter Baseline werden nicht gemergt.

Fehlender Kontext im Review

Falls Reviewer nach dem „Warum“ fragen, ergänze die Sektion „Summary“ in deinem PR. Nutze Beweise aus Logs oder Screenshots, um deine Argumente zu stützen.

Du brauchst Hilfe bei der Einrichtung? Frag den AI Setup Assistant.

Nächste Schritte

• PR und Issue Templates nutzen
• Codebase effektiv durchsuchen