Skip to main content

Hinzufügen einer Sicherheitsrichtlinie für dein Repository

Indem du eine Sicherheitsrichtlinie zu deinem Repository hinzufügst, kannst du festlegen, wie Sicherheitslücken in deinem Projekt gemeldet werden sollen.

Informationen zu Sicherheitsrichtlinien

Um Personen Anweisungen zum Melden von Sicherheitsrisiken in Ihrem Projekt zu geben, können Sie dem Stammverzeichnis docs Ihres Repositorys oder dem Ordner .github eine SECURITY.md-Datei hinzufügen. Wenn Sie diese Datei zu diesen Teilen Ihres Repositorys hinzufügen, wird automatisch eine Zeile mit einer Beschreibung erstellt, in der Benutzer sie überprüfen können. Wenn jemand ein Issue in deinem Repository erstellt, sieht er einen Link zu den Sicherheitsrichtlinien deines Projekts.

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

Tipp: Um den Benutzern das Auffinden der Sicherheitsrichtlinie zu erleichtern, kannst du an anderen Stellen in deinem Repository, z. B. in der README-Datei, die SECURITY.md-Datei verlinken. Weitere Informationen findest du unter Informationen zu README-Dateien.

Mit eindeutigen Anweisungen zur Sicherheitsberichterstellung erleichterst du deinen Benutzern, Sicherheitsrisiken, die sie in deinem Repository finden, über deinen bevorzugten Kommunikationskanal zu melden.

Ein Beispiel einer echten SECURITY.md-Datei finden Sie unter https://github.com/electron/electron/blob/main/SECURITY.md.

Hinzufügen einer Sicherheitsrichtlinie für dein Repository

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle unter dem Repositorynamen die Option Sicherheit aus. Wenn die Registerkarte „Sicherheit“ nicht angezeigt wird, wähle im Dropdownmenü die Option Sicherheit aus.

    Screenshot eines Repositoryheaders mit den Registerkarten. Die Registerkarte „Sicherheit“ ist dunkelorange umrandet.

  3. Klicke auf der linken Randleiste unter „Berichterstellung“ auf -Richtlinie.

  4. Klicke auf Start setup (Setup starten).

  5. Fügen Sie in der neuen SECURITY.md-Datei Informationen zu unterstützten Versionen Ihres Projekts sowie zur Art und Weise der Meldung von Sicherheitsrisiken hinzu.

  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. 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.

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

Weiterführende Themen