Haupt-Repo enthält nur allgemeines Plenty-Wissen. Shop-spezifische Lektionen (PID) werden als eigenes Repo in instances/ geklont. README + install.sh angepasst.
86 lines
2.9 KiB
Markdown
86 lines
2.9 KiB
Markdown
# Plenty Dojo
|
|
|
|
Gesammelte Lektionen aus der Arbeit mit der **Plentymarkets REST API** — von AI-Agenten für AI-Agenten.
|
|
|
|
Dieses Repo ist eine geteilte Wissensbasis, die Claude Code (oder andere AI-Coding-Agenten) beim Arbeiten mit Plentymarkets nutzen und erweitern.
|
|
|
|
## Was ist drin?
|
|
|
|
| Datei | Inhalt |
|
|
|-------|--------|
|
|
| `DOJO.md` | Allgemeine API-Patterns & Lektionen |
|
|
| `ANTI-PATTERNS.md` | Was man NICHT tun soll |
|
|
| `instances/` | Platz für shop-spezifische Lektionen (gitignored, siehe unten) |
|
|
|
|
## Installation
|
|
|
|
### 1. Repo klonen
|
|
|
|
```bash
|
|
git clone https://git.tradeo.de/sebastian/plenty-dojo.git ~/.claude/plenty-dojo
|
|
```
|
|
|
|
### 2. Install-Script ausführen
|
|
|
|
```bash
|
|
bash ~/.claude/plenty-dojo/install.sh
|
|
```
|
|
|
|
Das Script:
|
|
- Symlinkt den `/plenty-dojo` Skill nach `~/.claude/commands/`
|
|
- Erstellt eine Vorlage für deine Plenty-ID unter `instances/`
|
|
|
|
### 3. Shop-spezifische Lektionen einrichten (optional)
|
|
|
|
Das `instances/`-Verzeichnis ist für shop-spezifische Learnings (eigene Status-Codes, Workflows, IDs). Diese werden **nicht** ins Haupt-Repo gepusht.
|
|
|
|
**Option A — Eigenes PID-Repo (empfohlen für Teams):**
|
|
|
|
Wenn dein Team ein eigenes PID-Repo hat (z.B. `plenty-dojo-7843`), klone es als `instances/`:
|
|
|
|
```bash
|
|
rm -rf ~/.claude/plenty-dojo/instances
|
|
git clone <PID-REPO-URL> ~/.claude/plenty-dojo/instances
|
|
```
|
|
|
|
Danach kannst du shop-spezifische Änderungen separat committen und mit deinem Team teilen.
|
|
|
|
**Option B — Lokale Datei (nur für dich):**
|
|
|
|
Erstelle einfach eine Datei `instances/<DEINE-PID>.md` — sie wird vom Haupt-Repo ignoriert.
|
|
|
|
### 4. CLAUDE.md ergänzen
|
|
|
|
Füge in die `CLAUDE.md` deines Projekts (oder global in `~/.claude/CLAUDE.md`) ein:
|
|
|
|
```markdown
|
|
## Plenty Dojo
|
|
- Vor jeder Plenty-Integration die Dojo-Dateien lesen:
|
|
- `~/.claude/plenty-dojo/DOJO.md`
|
|
- `~/.claude/plenty-dojo/ANTI-PATTERNS.md`
|
|
- `~/.claude/plenty-dojo/instances/<DEINE-PID>.md` (falls vorhanden)
|
|
- Nach jedem Bugfix prüfen, ob ein neues Learning ins Dojo gehört (`/plenty-dojo lernen`).
|
|
```
|
|
|
|
## Nutzung
|
|
|
|
Der Skill wird über Claude Code aufgerufen:
|
|
|
|
| Befehl | Was passiert |
|
|
|--------|-------------|
|
|
| `/plenty-dojo` oder `/plenty-dojo lernen` | Analysiert die aktuelle Konversation und schlägt neue Einträge vor |
|
|
| `/plenty-dojo zeigen` | Zeigt alle Einträge mit Statistik |
|
|
| `/plenty-dojo suchen <begriff>` | Durchsucht alle Dojo-Dateien |
|
|
| `/plenty-dojo sync` | Holt neue Einträge von anderen und pusht eigene |
|
|
|
|
## Beitragen
|
|
|
|
Direkt in `DOJO.md` oder `ANTI-PATTERNS.md` schreiben und pushen. Der `/plenty-dojo lernen` Befehl hilft beim Formulieren — er analysiert die aktuelle Konversation, klassifiziert das Learning (allgemein vs. shop-spezifisch) und formatiert den Eintrag.
|
|
|
|
Jeder Eintrag enthält:
|
|
- **Lektion** — ein Satz
|
|
- **Warum** — was genau passiert ist
|
|
- **Pattern** — Codebeispiel (richtig)
|
|
- **Anti-Pattern** — Codebeispiel (falsch)
|
|
- **Entdeckt** — Datum + Kontext
|