README + Ein-Befehls-Lauf
Du hast ein sauberes Layout und echte Tests. Die letzte Meile ist der Teil, den Reviewer zuerst erreichen: die README und der eine Befehl, der das Ganze ausführt. Ein Projekt, das zehn Minuten Rätselraten zum Starten braucht, fühlt sich kaputt an, selbst wenn es funktioniert. Ein Projekt, das du mit einer einzigen Zeile klonen und ausführen kannst, fühlt sich professionell an, selbst wenn es klein ist. Derselbe Code -> völlig anderer Eindruck.
Die README ist ein Vertrag. Ein Leser überfliegt sie von oben nach unten und erwartet eine vorhersehbare Form: der Name des Projekts als Titel, dann wie man es installiert, dann wie man es benutzt, dann wie man es testet. Konkret hat eine starke README eine Titelzeile auf oberster Ebene (# Something), dann diese Abschnitte in dieser Reihenfolge:
# Triage Copilot
## Setup
pip install -e . # editable install
cp .env.example .env # then paste your real key into .env
## Usage
python -m triage # the one-command run
## Tests
pytest
Die Reihenfolge ist wichtig, weil ein Leser ihr als Schritte folgt. Die Verwendung vor dem Setup ist verwirrend -> du kannst nicht verwenden, was du nicht installiert hast. Also schreibst du einen Checker, validate_readme(text), der True nur zurückgibt, wenn ein # Titel erscheint, gefolgt von ## Setup, dann ## Usage, dann ## Tests, jeder nach dem vorherigen. Ein fehlender Abschnitt oder Abschnitte in der falschen Reihenfolge geben False zurück. Der Trick: gehe die Zeilen einmal durch, behalte einen "Cursor" davon, wo du bist, und erfordere, dass jeder Abschnitt an einer Position nach dem Cursor erscheint.
Der Ein-Befehls-Lauf. Beachte, dass die ## Usage Zeile oben ein einzelner Befehl ist. Das ist das Ziel eines Makefile oder justfile make run -> ein einprägsamer Befehl, der das Projekt startet, damit niemand den vollständigen Aufruf merken muss. Schreibe make_run(name) das diesen Befehlsstring für ein Projekt zurück, z. B. python -m triage (oder make run). Es muss den Projektnamen einbetten, normalisiert auf die gleiche Weise wie das Paketverzeichnis, damit ein anderes Projekt einen anderen Befehl ergibt.
Zwei ehrliche, nicht bewertete Notizen für das echte Repo. Erstens, Geheimnisse: der cp .env.example .env Schritt existiert, weil dein echter API-Key in .env landet, den du zu .gitignore und never commit hinzufügst. Du commitest nur .env.example -> die shape der Konfiguration mit Platzhalterwerten. Einen Key in ein öffentliches Repo zu leaken ist der klassische Portfolio-Projekt Fehler. Zweitens, deploying this: um es online zu stellen, würdest du ein kleines Dockerfile schreiben (kopiere das Repo, pip install, setze den run command als entrypoint) und zu einer PaaS wie Render, Railway oder Fly pushen. Dieser Teil kann nicht im Browser ausgeführt oder bewertet werden -> er liegt in deiner Hand, wenn du veröffentlichst. Drücke Run um eine vollständige README zu validieren und den run command zu drucken.
Schreibe die zwei deterministischen Teile einer guten README. validate_readme(text) gibt True zurück, wenn ein # Titel auf oberster Ebene erscheint, dann ## Setup, dann ## Usage, dann ## Tests, jeder nach dem vorherigen (ein fehlender Abschnitt oder falsch geordnete Abschnitte -> False). make_run(name) gibt den Ein-Befehls-Ausführungsstring zurück (z. B. python -m <pkg> oder make run), der den Projektnamen einbettet, normalisiert wie das Paketverzeichnis, sodass ein anderer Name einen anderen Befehl ergibt.
Ein Problem in dieser Lektion entdeckt? Melde es · Frage zu dieser Lektion
Diese Übung öffnet bald
Beende die vorherige Lektion, damit diese freigeschaltet wird. Der ganze Kurs ist kostenlos, kein Konto erforderlich, und du kannst diese Lektion jetzt direkt lesen.
Dieser Browser blockiert Cookies für learn.floati.life, daher können hier beendigte Lektionen nicht in der richtigen Reihenfolge geöffnet werden. Erlaube Cookies für diese Seite und lade sie neu.