Ein professionelles README mit GitHub Copilot erstellen

Öffnen oder Erstellen Ihrer README-Datei

Ihr erster Schritt ist das Öffnen der speziellen README.md-Datei in Ihrem Projekt. Falls sie noch nicht existiert, müssen Sie sie erstellen. Der .md-Teil bedeutet, dass es sich um eine Markdown-Datei handelt, eine einfache Möglichkeit, Text zu formatieren (z. B. Überschriften, Listen oder Fettschrift), die GitHub versteht.

Dazu schauen Sie sich den Explorer-Bereich auf der linken Seite Ihres VS Code-Fensters an – er zeigt alle Ihre Projektdateien und -ordner. Falls Sie ihn nicht sehen können, drücken Sie Strg + Umschalt + E (unter Windows/Linux) oder Cmd + Umschalt + E (auf Mac), um ihn anzuzeigen.

Aktion: Klicken Sie im Explorer-Bereich mit der rechten Maustaste auf den Hauptordner Ihres Projekts und wählen Sie dann „Neue Datei“. Geben Sie README.md genau wie gezeigt ein und drücken Sie Enter. Was Sie sehen: Ein neues Eingabefeld für den Dateinamen erscheint im Explorer-Bereich. Was als Nächstes passiert: Die neue Datei README.md wird als leeres Dokument im Haupteditorbereich von VS Code geöffnet. Wenn es anders aussieht: Wenn Sie bereits eine Datei README.md haben, klicken Sie einfach im Explorer-Bereich darauf, um sie zu öffnen, und löschen Sie dann vorhandenen Text, wenn Sie für diese Anleitung neu beginnen möchten.

Sie wissen, dass es funktioniert hat, wenn eine leere Datei namens README.md im Haupteditorbereich von VS Code erscheint, bereit für Ihre Eingaben.

Beginnen Sie Ihre Projektbeschreibung

Nachdem Ihre Datei README.md geöffnet ist, bitten wir Copilot, bei der Hauptbeschreibung zu helfen. GitHub Copilot verwendet eine sogenannte „Autovervollständigung“, die ähnlich wie die prädiktive Texteingabe auf Ihrem Telefon ist, aber viel intelligenter. Es nutzt künstliche Intelligenz (KI), um auf der Grundlage Ihres Kontexts zu erraten, was Sie als Nächstes schreiben möchten.

Aktion: Platzieren Sie Ihren blinkenden Cursor in der allerersten Zeile Ihrer Datei README.md, geben Sie eine kurze Überschrift für Ihr Projekt ein und drücken Sie dann die Enter-Taste. Was Sie sehen: Nachdem Sie die Überschrift eingegeben haben, erscheint normalerweise direkt nach Ihrem Cursor ein ausgegrauter Vorschlag von Copilot. Was als Nächstes passiert: Copilot liest Ihre kurze Überschrift und beginnt automatisch, einen vollständigen Absatz zur Beschreibung Ihres Projekts vorzuschlagen. Wenn der Vorschlag gut aussieht, drücken Sie die Tab-Taste, um ihn zu übernehmen. Wenn Sie eine andere Option wünschen, drücken Sie Strg + Leertaste (unter Windows/Linux) oder Option + Leertaste (auf Mac), um verschiedene Vorschläge durchzugehen, bis Sie einen finden, der Ihnen gefällt. Wenn es anders aussieht: Wenn Copilot nicht sofort einen Vorschlag anbietet, stellen Sie sicher, dass die GitHub Copilot-Erweiterung aktiviert ist (suchen Sie in der unteren rechten Ecke von VS Code nach einem kleinen Copilot-Symbol). Sie können auch versuchen, ein paar weitere Wörter einzugeben, bevor Sie erneut Enter drücken.

Sie wissen, dass es funktioniert hat, wenn Copilot einen ausgegrauten Textvorschlag direkt in Ihrem Editor präsentiert und Sie eine Beschreibung durch Drücken von Tab akzeptiert haben.

Eine Installationsanleitung generieren

Die meisten Projekte benötigen Anweisungen zur Einrichtung. Copilot kann auch dabei helfen, diese gängigen Abschnitte zu generieren. Es errät oft intelligent, welche Programmiersprache Ihr Projekt aus anderen Dateien in Ihrem Repository verwendet, und schlägt relevante Befehle vor.

Aktion: Bewegen Sie Ihren Cursor ein paar Zeilen nach unten (drücken Sie Enter ein paar Mal, um etwas Platz zu schaffen), geben Sie ## Installation ein, drücken Sie Enter, dann geben Sie einen kurzen Hinweis wie Führen Sie den folgenden Befehl aus: ein und drücken Sie Enter. Was Sie sehen: Ihre neue Überschrift, gefolgt von Ihrem Hinweis, und dann ein ausgegrauter Vorschlag für einen Installationsbefehl. Was als Nächstes passiert: Copilot vervollständigt normalerweise automatisch einen Shell-Befehl (einen Befehl, den Sie in das Terminal eines Computers eingeben würden) wie npm install (für JavaScript-Projekte) oder pip install -r requirements.txt (für Python-Projekte). Wenn es anders aussieht: Wenn der vorgeschlagene Befehl nicht der Sprache oder dem Paketmanager (dem Tool, das Softwarekomponenten verwaltet) Ihres Projekts entspricht, löschen Sie ihn einfach und geben Sie einen spezifischeren Hinweis ein. Zum Beispiel: Python-Abhängigkeiten installieren: wenn es npm install für Ihr Python-Projekt vorgeschlagen hat.

Sie wissen, dass es funktioniert hat, wenn Copilot eine Befehlszeile zur Installation von Abhängigkeiten vorschlägt und Sie diese durch Drücken von Tab akzeptiert haben.

Ein Anwendungsbeispiel hinzufügen

Sobald ein Projekt installiert ist, müssen die Leute wissen, wie man es benutzt! Wir können ein ähnliches Muster befolgen, um Copilot dazu zu bringen, einen Befehl zum Starten Ihrer Anwendung zu generieren.

Aktion: Bewegen Sie Ihren Cursor nach dem Installationsabschnitt ein paar Zeilen nach unten, geben Sie ## Usage ein, drücken Sie Enter, dann schreiben Sie einen kurzen Hinweis wie Starten Sie die App mit: und drücken Sie Enter. Was Sie sehen: Ihre neue Überschrift und Ihr Hinweis, gefolgt vom vorgeschlagenen Befehl von Copilot. Was als Nächstes passiert: Copilot schlägt einen Befehl wie npm start oder python app.py vor, basierend auf dem, was es über Ihr Projekt ableitet. Akzeptieren Sie den passenden Befehl, indem Sie Tab drücken. Wenn es anders aussieht: Wenn der vorgeschlagene Befehl leicht daneben liegt, können Sie ihn akzeptieren und die Zeile dann manuell bearbeiten, um sie für Ihr Projekt genau zu machen. Sie könnten auch eine kurze, einfache englische Beschreibung unter dem Befehl hinzufügen, um zu verdeutlichen, was er tut, z. B. „Dies startet den lokalen Server auf http://localhost:5000“.

Sie wissen, dass es funktioniert hat, wenn Copilot einen Befehl zum Starten Ihres Projekts anbietet und Sie ihn akzeptiert haben.

Eine Projektübersicht einfügen

Ein gutes README schließt oft mit einer kurzen Zusammenfassung ab, was das Projekt erreichen soll oder welche Schlüsseltechnologien es verwendet. Lassen Sie uns Copilot eine schnelle Übersicht geben.

Aktion: Bewegen Sie Ihren Cursor ein paar Zeilen unter dem Abschnitt zur Nutzung nach unten, geben Sie ## Overview ein, drücken Sie Enter, dann tippen Sie ein paar beschreibende Wörter wie Dieses Projekt demonstriert... und drücken Sie Enter. Was Sie sehen: Ihre neue ## Overview-Überschrift, gefolgt von Ihrem Hinweis, und dann ein detaillierterer Zusammenfassungsvorschlag von Copilot. Was als Nächstes passiert: Copilot füllt einen prägnanten Absatz aus, der den Zweck und die Highlights Ihres Projekts zusammenfasst. Wenn es anders aussieht: Wenn die Zusammenfassung zu allgemein ist, können Sie Ihrem anfänglichen Hinweis spezifischere Schlüsselwörter hinzufügen (z. B. Dieses Projekt demonstriert Datenabruf und UI-Komponenten...), um Copilot zu einer maßgeschneiderteren Antwort zu führen.

Sie wissen, dass es funktioniert hat, wenn Copilot Ihnen einen kurzen, beschreibenden Absatz zur Zusammenfassung Ihres Projekts gibt, den Sie dann akzeptieren können.

Mit einem Lizenzhinweis abschließen

Es ist gute Praxis, die Lizenz für Ihr Projekt anzugeben. Dies teilt anderen mit, wie sie Ihren Code verwenden, ändern und verteilen dürfen. Die MIT-Lizenz ist eine sehr gängige und permissive Wahl für Open-Source-Projekte.

Aktion: Fügen Sie unter Ihrem Abschnitt Overview eine neue Überschrift hinzu, indem Sie ## License eingeben und dann Enter drücken. Geben Sie in der nächsten Zeile This project is licensed under the MIT License. ein. Was Sie sehen: Die neue Überschrift und die Lizenzaussage, die in Ihrer Datei README.md erscheinen. Was als Nächstes passiert: Sie haben nun die wesentlichen Abschnitte Ihrer README-Datei fertiggestellt. Copilot generiert normalerweise keinen spezifischen Lizenztext automatisch, es sei denn, er wird stark dazu aufgefordert, daher ist es eine gute Idee, einen gängigen manuell hinzuzufügen. Wenn es anders aussieht: Wenn Sie eine andere Lizenz benötigen, können Sie online nach gängigen Lizenztexten suchen (z. B. „Apache 2.0 Lizenztext“) und die entsprechende Aussage in diesen Abschnitt kopieren.

Sie wissen, dass es funktioniert hat, wenn der Abschnitt ## License in Ihrer Datei README.md sichtbar und vollständig ist.