Hinzufügen von Supportressourcen zu deinem Projekt

Du kannst eine SUPPORT-Datei erstellen, um anderen mitzuteilen, wie sie Unterstützung in Deinem Projekt erhalten.

Um Personen auf bestimmte Supportressourcen zu verweisen, kannst du im Stammverzeichnis im Ordner docs oder .github deines Repositorys eine SUPPORT-Datei hinzufügen. Wenn jemand einen Issue in Deinem Repository erstellt, wird ihm ein Link zur SUPPORT-Datei Deines Projekts angezeigt.

Screenshot des Formulars „Issue“. Auf der rechten Randleiste im Abschnitt „Nützliche Ressourcen“ ist ein Link mit der Bezeichnung „Support“ dunkelorange umrandet.

Du kannst Standardsupportressourcen für deine Organisation oder dein persönliches Konto erstellen. Weitere Informationen findest du unter Erstellen einer Standard-Community-Health-File.

Tipp: Um Benutzer*innen das Auffinden der Supportrichtlinie zu vereinfachen, kannst du an anderen Stellen in deinem Repository, z. B. in der Datei README-Datei auf die SUPPORT-Datei verweisen.

Hinzufügen von Supportressourcen zu deinem Projekt

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle über der Dateiliste das Dropdownmenü Datei hinzufügen aus, und klicke dann auf Neue Datei erstellen.

    Alternativ kannst du in der Dateistrukturansicht links auf klicken.

    Screenshot der Hauptseite eines Repositorys. Oberhalb der Dateiliste ist eine Schaltfläche mit der Bezeichnung „Datei hinzufügen“ dunkelorange umrandet. In der Dateistrukturansicht des Repositorys ist eine Schaltfläche mit einem Pluszeichensymbol ebenfalls dunkelorange hervorgehoben.

  3. Gib im Feld für den Dateinamen SUPPORT.md (in Großbuchstaben) ein.

  4. Füge auf der Registerkarte Neue Datei bearbeiten Informationen zu den Supportmöglichkeiten bei deinem Projekt hinzu.

  5. Um deine SUPPORT-Datei zu überprüfen, klickest du auf Vorschau.

  6. Klicke auf Änderungen committen... .

  7. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Einen Commit mit mehreren Autoren erstellen.

  8. Wenn Ihrem Konto in GitHub mehrere E-Mail-Adressen zugeordnet sind, klicken Sie auf das Dropdownmenü für E-Mail-Adressen und wählen Sie die Adresse aus, die als Git-Autor-Adresse für den verwendet werden soll. Nur verifizierte E-Mail-Adressen werden in diesem Dropdownmenü angezeigt. Wenn Sie den Datenschutz für E-Mail-Adressen aktiviert haben, ist die Commitautor-Standardadresse No-reply. Weitere Informationen zur genauen Form der No-reply-E-Mail-Adresse finden Sie unter „E-Mail-Adresse für Commits festlegen“.

    Screenshot eines GitHub-Pull Requests mit einem Dropdownmenü mit Optionen zum Auswählen der Commit-E-Mail-Adresse des Autors. octocat@github.com ist ausgewählt.

  9. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Dein Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. Wenn dein aktueller Branch als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen findest du unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.

  10. Klicke auf Änderungen committen oder Änderungen vorschlagen.