Übung: Erstellen Ihres ersten Pull Requests

  • 6 Minuten

Sie können bereits einen Pull Request (PR) mithilfe einer Vorlage oder einer CONTRIBUTING-Datei erstellen. Doch was tun Sie, wenn ein Projekt keine solchen Hilfsmittel und keine Dokumentation zu Konventionen enthält?

Beschreiben von Änderungen

Gehen Sie folgendermaßen vor, um eine gute Commitnachricht zu schrieben und anschließend einen Pull Request zu erstellen:

  • Die Betreffzeile Ihrer Git-Commitnachricht sollte den folgenden Satz vervollständigen:
    • Bei Anwendung wird dieser Commit <your subject line here>.
  • Schließen Sie eine Kurzbeschreibung der Änderung ein, in der Sie den Imperativ und das Präsens verwenden. Verwenden Sie beispielsweise hinzufügen und nicht hinzugefügt oder fügt hinzu.
  • Beschränken Sie die Betreffzeile auf 50 Zeichen.
  • Beginnen Sie mit einem Großbuchstaben, und beenden Sie die Betreffzeile nicht mit einem Punkt (.).
  • Sie können Emojis in der Betreffzeile verwenden oder andere GitHub-Benutzer mit @mention erwähnen. Manche Benutzer könnten das jedoch als störend empfinden.

Verwenden Sie für den Nachrichtentext und den Pull Request weiterhin das Präsens. Stellen Sie sicher, dass Sie den Grund für die Änderung erwähnen. Ziehen Sie einen Vergleich zum vorherigen Verhalten. Nutzen Sie den verfügbaren Platz, um das Was, Warum und das Wie zu erklären.

Ihre Commitnachricht sollte sich nur auf den Inhalt beziehen, den Sie übermitteln möchten. Sie sollten geringfügige, isolierte Änderungen committen oder für die Überprüfung einreichen. Dadurch wird die Wahrscheinlichkeit erhöht, dass Ihre Änderungen in das Projekt gemergt werden.

Hinzufügen von Granularität

Überprüfen Sie, ob die Randleiste noch Empfehlungen zur Vervollständigung Ihres PR enthält, bevor Sie diesen übermitteln. Wählen Sie Reviewer oder Assignees (Zugewiesene Personen) aus, wenn Sie mit der Teamstruktur des Projekts vertraut sind. Fügen Sie Labels hinzu, wenn diese empfohlen werden (z. B. bei einer CONTRIBUTING.md-Datei). Sie können Labels als visuelle Hinweise für Ihre Absichten verwenden. Auch ein Maintainer kann ein oder mehrere Labels hinzufügen.

Im Repository für dieses Learn-Modul werden beispielsweise folgende Labels verwendet:

  • Bug (Fehler, rot): Etwas funktioniert nicht.
  • Documentation (Dokumentation, blau): Es gibt Verbesserungen oder Ergänzungen im Zusammenhang mit der Dokumentation.
  • Duplicate (Duplikat, grau): Dieses Issue oder dieser Pull Request ist bereits vorhanden.
  • Enhancement (Verbesserung, blaugrün): Es gibt ein neues Feature oder eine neue Anforderung.

Optional können Sie Issues auf der Randleiste verlinken, wobei das erfolgreiche Mergen eines Pull Requests dazu führen könnte, dass das zugehörige Issue geschlossen wird. Sie können Ihr Abonnement auch so anpassen, dass Benachrichtigungen im Thread angezeigt werden. Einige PRs erhalten viele Kommentare, Reviews und CI/CD-bezogene Benachrichtigungen. Es gibt folgende Auswahlmöglichkeiten:

  • Nicht abonniert: Sie empfangen nur Benachrichtigungen, wenn Sie am Projekt beteiligt waren oder über @mentioned erwähnt wurden.
  • Abonniert: Sie erhalten alle Benachrichtigungen für diesen Pull Request.
  • Benutzerdefiniert: Sie erhalten nur Benachrichtigungen für die ausgewählten Ereignisse.

Übung

Im Projekt First Contributions können Sie das Forken, Klonen und Übermitteln eines Pull Requests üben. Das Projekt „First Contributions“ soll „Einsteiger bei ihrem ersten Beitrag unterstützen“. Es enthält Anleitungen für die Verwendung der Befehlszeile und verschiedener GUIs (Graphical User Interface, grafische Benutzeroberfläche). Das Projekt bietet Unterstützung für mehrere Sprachen. Stellen Sie sicher, dass Sie den Ordner Translations überprüfen.

Behalten Sie das in der vorherigen und in dieser Lerneinheit Gelernte im Hinterkopf, und wechseln Sie zurück zu einem kürzlich geöffneten Pull Request. Sie können auch zur Registerkarte „Pull Requests“ eines Projekts wechseln, das Sie beobachten. Denken Sie daran, dass eine gute Betreffzeile den Unterschied ausmachen kann. Sie sollten den Pull Request entsprechend aktualisieren. Investieren Sie ungefähr so viel Zeit in das Erstellen des PR wie in das Bearbeiten des Projekts. Ihre Bemühungen helfen den Maintainern, Communitybeiträge zu kategorisieren und zu priorisieren (Selektierung).

Bonus: Lesen Sie die Barrierefreiheitsrichtlinien und -anforderungen von Microsoft. Lesen Sie sich insbesondere die Informationen zum Beschreiben von Interaktionen mit der Benutzeroberfläche durch, um ableistische Sprache in Ihren Beiträgen zu vermeiden. Kunden nutzen verschiedene Eingabemethoden für die Interaktion mit Produkten. Beispielsweise können sie unter anderem die Tastatur, eine Maus sowie Gesten und Sprachbefehle verwenden. Sie sollten generische Verben verwenden, die bei jeder Eingabemethode funktionieren. Verwenden Sie beispielsweise die Formulierung Wählen Sie anstelle der eingabespezifischen Befehle klicken oder wischen.