Prompts

README prüfen: Klappt der Einstieg für Neue? (Prompt)

Geht deine README Schritt für Schritt durch wie ein Neuling und prüft sie gegen dein Repo. Du fügst README, Dateiliste, package.json (o. Ä.) und .env.example ein.

Sprachen: English · Español

Aus dem englischen Prompt übersetzt. Die englische Version ist die, die wir getestet haben.

Der Prompt

Kopiere den Prompt, füge ihn in deinen Chatbot ein und ersetze die Texte in eckigen Klammern durch dein Material. Der Assistent antwortet auf Deutsch.

Schreibe deine gesamte Antwort auf Deutsch (zitierten Quelltext, Befehle, Dateinamen und die Status-Labels OK, BROKEN, MISSING und UNVERIFIED lässt du in der Originalsprache).

Du bist ein neuer Nutzer, der der README eines Projekts folgt. Arbeite nur mit den Dateien, die ich unten einfüge. Rate nie eine Version, einen Befehl oder eine Datei. Markiere alles, was du nicht prüfen kannst, als UNVERIFIED und sag, welche Datei du dafür bräuchtest.

1. Liste jeden Schritt, den ein Neuling befolgen muss, als nummerierte Liste auf: Voraussetzungen und Versionen, Klonen und Installieren, Konfiguration und Umgebungsvariablen, Dienste, Starten, Testen, URLs und Ports. Zitiere die README kurz.
2. Sag zu jedem Schritt: OK (die Belege passen, nenne die Datei und die Zeile oder den Schlüssel), BROKEN (die Belege widersprechen ihm), MISSING (ein Neuling braucht etwas, das die README nicht sagt) oder UNVERIFIED. Prüfe, ob die in der README genannten Skripte im Manifest existieren, ob verwiesene Dateien und Links in der Dateiliste stehen, ob Versionen über die Dateien hinweg übereinstimmen und ob die Befehle in einer brauchbaren Reihenfolge stehen.
3. Beschreibe den echten ersten Durchlauf: worauf ein Neuling, der der README genau folgt, zuerst stößt, dann als Zweites und so weiter, und wo er steckenbleibt.
4. Gib die README-Änderungen an, die jedes Problem beheben, als konkrete Ersatzzeilen, geordnet danach, wie früh ein Neuling darauf trifft.
Führe nichts aus und ändere nichts.

Hier sind meine Dateien:

Ein echtes Beispiel (auf Englisch)

Das Beispiel bleibt auf Englisch, weil es das Ergebnis des ursprünglichen Tests ist. Der übersetzte Prompt antwortet auf Deutsch.

The README of a small public React tutorial app says to run yarn && yarn start.

After (skill output, excerpt):
Short answer: no. The one command the README gives, yarn && yarn start, stops at the second half, because the project has no start script.
4 | yarn start | BROKEN | package.json scripts are only dev, build, lint and preview. There is no start.
1 | Install Node.js | MISSING version | .nvmrc says v24. The README gives no version.
Run command: yarn / yarn dev

Grenzen

  • Standardmäßig nur lesend, deshalb bleiben manche Schritte UNVERIFIED.
  • Er kann nicht sehen, was nicht im Repo steht.
  • Er schlägt README-Änderungen vor, nimmt sie aber nicht vor.

Mehr