Mit GitHub Copilot in 10 Minuten eine klare README-Datei erstellen

Ihr Repository öffnen und die README-Datei starten

Öffnen Sie Ihr Repository auf GitHub in Ihrem Browser. Sie landen auf der Hauptseite, die Ihre Projektdateien anzeigt. Suchen Sie nach einer Liste von Dateien; wenn Sie das Repository gerade erst erstellt haben, sehen Sie möglicherweise nur eine .gitignore-Datei oder noch gar nichts. Klicken Sie oben rechts in der Dateiliste auf Add file und wählen Sie Create new file. Benennen Sie die Datei README.md. Das .md steht für „Markdown“, eine einfache Möglichkeit, Text mit Symbolen wie # für Überschriften zu formatieren.

Sie sehen einen leeren Editor mit einem Platzhalter: „Write a new file in …“. Der Dateiname README.md teilt GitHub mit, dass dies die Willkommensseite des Projekts ist.

Sie wissen, dass es funktioniert hat, wenn Sie den Dateinamen README.md oben im Editor sehen und der Seitentitel „Create new file“ lautet.

Copilot bitten, die README-Struktur zu generieren

Drücken Sie bei geöffneter Datei die Schaltfläche Ask Copilot (normalerweise ein Chat-Symbol oder ein Glitzerstern) in der oberen rechten Ecke des Editors. Wenn Sie sie nicht sehen, suchen Sie in der Symbolleiste nach einem Copilot-Symbol oder verwenden Sie die Tastenkombination Strg+I (Windows/Linux) oder Cmd+I (Mac). Ein Chat-Panel öffnet sich auf der rechten Seite.

Geben Sie im Chat-Feld ein:

Drücken Sie Enter. Copilot antwortet mit einer vorgeschlagenen Struktur, die Markdown-Überschriften wie # Beschreibung, ## Funktionen usw. verwendet. Es kann auch einen kurzen Platzhalter-Absatz unter jeder Überschrift hinzufügen.

Sie wissen, dass es funktioniert hat, wenn eine Liste von Überschriften und kurze Beschreibungen im Editor erscheinen und die leere Seite ersetzen.

Die Projektbeschreibung ausfüllen

Scrollen Sie zum Abschnitt # Beschreibung, den Copilot erstellt hat. Ersetzen Sie den Platzhaltertext durch eine klare, einzeilige Erklärung Ihres Projekts. Wenn Ihr Projekt beispielsweise ein Python-Skript ist, das Wörter zählt, schreiben Sie:

Sie wissen, dass es funktioniert hat, wenn die Beschreibung wie eine freundliche Einführung klingt und natürlich unter die Überschrift passt.

Die Funktionen des Projekts auflisten

Unter der Überschrift ## Funktionen hat Copilot wahrscheinlich eine Aufzählungsliste hinzugefügt. Ersetzen Sie jeden Punkt durch eine kurze, aktive Phrase, die beschreibt, was Ihr Projekt tut. Für einen Wortzähler könnte es so aussehen:

• Funktioniert mit .txt-Dateien unter Windows, macOS und und Linux
• Leichtgewichtig und läuft in Sekunden
• Keine externen Bibliotheken erforderlich

Sie wissen, dass es funktioniert hat, wenn die Liste in einfacher Sprache klar zeigt, was das Projekt leisten kann.

Installationsanweisungen hinzufügen

Scrollen Sie zum Abschnitt ## Installation. Copilot schlägt normalerweise Befehle wie pip install oder git clone vor. Ersetzen Sie den Platzhalter durch Schritt-für-Schritt-Anweisungen für Ihr Betriebssystem. Für ein anfängerfreundliches Python-Projekt schreiben Sie:

python --version Wenn Sie Python 3.x sehen, sind Sie startklar. 2. Laden Sie dieses Projekt herunter oder klonen Sie es: git clone https://github.com/ihr-benutzername/ihr-repo.git 3. Wechseln Sie in den Projektordner: cd ihr-repo 4. Installieren Sie das erforderliche Paket (falls vorhanden): pip install -r requirements.txt (Wenn keine requirements.txt vorhanden ist, überspringen Sie diesen Schritt.)

Sie wissen, dass es funktioniert hat, wenn die Anweisungen klar genug sind, damit jemand mit grundlegenden Computerkenntnissen sie ohne Verwirrung befolgen kann.

Ein Anwendungsbeispiel schreiben

Unter der Überschrift ## Nutzung fügt Copilot oft einen Codeblock mit einem Befehl wie python wordcounter.py hinzu. Ersetzen Sie ihn durch ein einfaches, kopierfähiges Beispiel. Für einen Wortzähler schreiben Sie:

python wordcounter.py sample.txt

Sie wissen, dass es funktioniert hat, wenn das Beispiel kurz ist, echte Dateinamen verwendet und genau zeigt, was einzugeben ist.

Eine Lizenz auswählen und hinzufügen

Scrollen Sie zum Abschnitt ## Lizenz. Copilot schlägt möglicherweise einen Platzhalter wie „MIT-Lizenz“ oder „Apache 2.0“ vor. Ersetzen Sie ihn durch eine kurze Erklärung und einen Link zur Lizenzdatei. Für Anfänger ist die MIT-Lizenz einfach und weit verbreitet. Schreiben Sie:

Sie wissen, dass es funktioniert hat, wenn der Lizenzabschnitt klar den Lizenztyp angibt und auf eine Datei namens LICENSE in Ihrem Repository verweist.