Entscheiden, was mitkommt

Ein ausführbares Projekt ist keine Momentaufnahme eines Rechners. Teile die Entscheidungen, die jemand zum Wiederaufbau braucht: Quellcode, Dokumentation, Abhängigkeitsdateien und Tests. Teile weder die abgeleitete Umgebung noch Caches, Geheimnisse, Protokolle oder Antwort-JSON, das der Befehl zufällig erzeugt hat.

Erstelle README.md und beginne mit dem Projekttitel API Catalog sowie einem Abschnitt Project files. Nenne die endgültige Struktur der selbst verfassten Dateien:

API_CONTRACT.md
README.md
api_catalog.py
requirements-dev.txt
requirements.txt
tests/test_api_catalog.py

Zu diesem Zeitpunkt müssen nur der Quellcode aus Kapitel 11, die API-Notiz, die Laufzeit-Abhängigkeitsdatei und die neue README vorhanden sein. Füge keine .gitignore hinzu: Python-Land-Arbeitsbereiche weisen Punktpfade bewusst zurück. Die Abnahme des sauberen Quellcodes prüft, dass abgeleitete, private und Ausgabedateien fehlen, statt eine Ignorierregel zu bewerten.

Das heruntergeladene ZIP enthält später zusätzlich eine erzeugte PYTHONLAND_README.md. Diese Anleitung ist nicht deine Projekt-README und gehört nicht zur gespeicherten Dateistruktur des Arbeitsbereichs. Die Quellcodebewertung kann nicht belegen, dass im angemeldeten Zustand auf den Download geklickt wurde.

Bist du unsicher, ob eine Datei zur Übergabe gehört? Frage Monty: „Habe ich das selbst geschrieben, oder haben meine Werkzeuge es erzeugt?“ Fast jeder Fall in diesem Kapitel lässt sich mit dieser einen Frage entscheiden.