Kommunikation über GitHub

Einführung

GitHub bietet integrierte Kommunikationstools für die Zusammenarbeit, mit denen Sie eng mit Ihrer Community interagieren können. In diesem Schnellstart erfährst du, wie du das richtige Tool für deine Anforderungen auswählst.

Je nach Art der gewünschten Konversation kannst du Issues, Pull Requests und Teamdiskussionen erstellen und daran teilnehmen.

GitHub Issues

• Sind nützlich bei der Erörterung spezifischer Details eines Projekts, zum Beispiel Fehlerberichte, geplante Verbesserungen und Feedback
• Sind spezifisch für ein Repository, und ihnen ist in der Regel ein eindeutiger Besitzer zugeordnet
• Werden oft als Fehlerverfolgungssystem von GitHub bezeichnet

Pull Requests

• Ermöglichen das Vorschlagen bestimmter Änderungen
• Ermöglichen es, von anderen vorgeschlagene Änderungen direkt zu kommentieren
• Sind spezifisch für ein Repository

GitHub Discussions

• Sie sind wie ein Forum und eignen sich am besten für offene Anregungen und Diskussionen, bei denen die Zusammenarbeit wichtig ist.
• Können mehrere Repositorys umfassen
• Bieten eine Funktion für die Zusammenarbeit jenseits der Codebasis, die das Brainstorming von Ideen und den Aufbau einer Community-Wissensdatenbank ermöglicht
• Weisen häufig keinen eindeutigen Besitzer auf
• Führen häufig nicht zu einer umsetzbaren Aufgabe

Welches Diskussionstool sollte ich verwenden?

Szenarien für Probleme

• Ich möchte Aufgaben, Verbesserungen und Fehler nachverfolgen.
• Ich möchte einen Fehlerbericht erstellen.
• Ich möchte Feedback zu einem bestimmten Feature teilen.
• Ich möchte eine Frage zu Dateien im Repository stellen.

Beispiel für ein Problem

Dieses Beispiel zeigt, wie ein GitHub Benutzer in unserem Open-Source-Repository für die Dokumentation ein Issue erstellt hat, um uns auf einen Fehler aufmerksam zu machen und eine Behebung zu besprechen.

• Ein Benutzer bemerkte, dass die blaue Farbe des Banners oben auf der Seite in der chinesischen Version der GitHub Dokumente den Text im Banner unlesbar macht.
• Der Benutzer hat ein Issue im Repository erstellt, in dem das Problem beschrieben und ein Fix vorgeschlagen wird (Verwendung einer anderen Hintergrundfarbe für das Banner).
• Es folgt eine Diskussion, und schließlich wird gemeinsam entschieden, welche Korrekturmaßnahmen angewendet werden sollen.
• Anschließend kann ein Mitwirkender einen Pull Request mit dem Fix erstellen.

Szenarien für Pull Requests

• Ich möchte einen Tippfehler in einem Repository korrigieren.
• Ich möchte Änderungen an einem Repository vornehmen.
• Ich möchte Änderungen zum Beheben eines Problems vornehmen.
• Ich möchte von anderen Benutzern vorgeschlagene Änderungen kommentieren.

Pull Request-Beispiel

Dieses Beispiel zeigt, wie ein GitHub Nutzer in unserem Open-Source-Repository für die Dokumentation einen Pull Request erstellt hat, um einen Tippfehler zu beheben.

Auf der Registerkarte Unterhaltung des Pull Requests erläutert der Autor, warum er den Pull Request erstellt hat.

Die Registerkarte Geänderte Dateien für den Pull Request zeigen den implementierten Fix.

• Dieser Mitwirkende bemerkt einen Tippfehler im Repository.
• Der Benutzer erstellt einen Pull Request mit dem Fix.
• Ein Repositoryverantwortlicher prüft den Pull-Request, kommentiert ihn und führt ihn zusammen.

Szenarien für GitHub Discussions

• Ich habe eine Frage, die sich nicht unbedingt auf bestimmte Dateien im Repository bezieht.
• Ich möchte Neuigkeiten mit meinen Mitstreitern oder meinem Team austauschen.
• Ich möchte eine offene Diskussion beginnen oder daran teilnehmen.
• Ich möchte eine Ankündigung an meine Community richten.

GitHub Discussions Beispiel

Dieses Beispiel zeigt den GitHub Discussions Willkommensbeitrag für das Open-Source-Repository GitHub Docs und veranschaulicht, wie das Team mit seiner Community zusammenarbeiten möchte.

Dieser Communityverantwortliche hat eine Diskussion gestartet, um die Community zu begrüßen und die Mitglieder zu bitten, sich vorzustellen. Dieser Beitrag fördert eine einladende Atmosphäre für Besucher und Mitwirkende. Außerdem wird betont, dass das Team gerne bei Beiträgen zum Repository behilflich ist.

Verwenden von Copilot, um den Kontext zu erfassen

Wenn Sie mehr Kontext oder Klarheit zu einem bestimmten Problem oder einer bestimmten Diskussion benötigen, können Sie verwenden GitHub Copilot , um Ihre Fragen zu beantworten. Auf diese Weise kannst du schnell Einblicke gewinnen, komplexe Threads nachvollziehen und die Projektziele einhalten. Dadurch wird die Zusammenarbeit und der Wissensaustausch innerhalb der Community gefördert.

So stellst du eine Frage zu einem Problem oder einer Diskussion:

1. Von jeder Seite auf GitHub aus klicken Sie auf das -Symbol neben der Suchleiste oben rechts auf der Seite.

   

2. Geben Sie im Feld "Frage Copilot" eine Frage ein, und fügen Sie die relevante URL in Ihre Nachricht ein. Sie könnten z. B. fragen:

   • Explain https://github.com/monalisa/octokit/issues/1
   • Summarize https://github.com/monalisa/octokit/discussions/4
   • Recommend next steps for https://github.com/monalisa/octokit/issues/2
   • What are the acceptance criteria for ISSUE URL?
   • What are the main points made by PERSON in DISCUSSION URL?

   Wenn Sie ausgehend von einem bestimmten Problem oder einer bestimmten Diskussion mit GitHub Copilot chatten, müssen Sie die URL in Ihrer Frage nicht angeben.

3. Optional kannst du nach der Übermittlung einer Frage im Textfeld auf klicken, um die Antwort zu beenden.

Nächste Schritte

Diese Beispiele haben Ihnen gezeigt, wie Sie entscheiden, welches Tool für Ihre Unterhaltungen auf GitHub am besten geeignet ist. Aber das ist nur der Anfang. Es gibt viele weitere Möglichkeiten, wie du diese Tools an deine Bedürfnisse anpassen kannst.

Issues kannst du zum Beispiel für eine schnellere Suche mit Bezeichnungen versehen, und du kannst Vorlagen für Issues erstellen, mit denen Mitwirkende aussagekräftige Issues öffnen können. Weitere Informationen findest du unter Informationen zu Problemen und Informationen zu Vorlagen für Issues und Pull Requests.

Für Pull Requests kannst du Entwürfe erstellen, wenn deine Änderungsvorschläge noch in Arbeit sind. Entwürfe von Pull Requests können erst zusammengeführt werden, wenn sie als bereit zur Überprüfung markiert sind. Weitere Informationen finden Sie unter Informationen zu Pull Requests.

Für GitHub Discussions können Sie einen Verhaltenskodex einrichten und Diskussionen anheften, die wichtige Informationen für Ihre Community enthalten. Weitere Informationen finden Sie unter Informationen zu Diskussionen.

Einige fortgeschrittene Formatierungsfeatures, die dir die Kommunikation erleichtern, findest du unter Schnellstart zum Schreiben auf GitHub.