Erstellen einer README-Datei
Damit es für andere einfacher ist, deine Arbeit nachzuvollziehen und sich darin zurechtzufinden, empfehlen wir, dass du für jedes Repository eine README-Datei erstellst.
Du kannst einem Repository eine README-Datei hinzufügen, um wichtige Informationen zu Deinem Projekt zu kommunizieren. Eine README-Datei in Verbindung mit einer Repositorylizenz, Zitatdatei sowie Beitragsrichtlinien kommuniziert Erwartungen an Dein Projekt und unterstützt Dich bei der Verwaltung von Beiträgen. Weitere Informationen findest du unter Informationen zu README-Dateien.
Branching anstelle von Forking
Zur Vereinfachung der Zusammenarbeit empfehlen wir, dass reguläre Mitarbeiter von einem einzigen Repository aus arbeiten und Pull Requests nicht zwischen Repositorys, sondern zwischen Branches erstellen. Das Forking eignet sich am besten für die Aufnahme von Beiträgen von Personen, die nicht direkt an einem Projekt beteiligt sind, wie z. B. Open-Source-Mitwirkende.
Um bei Nutzung eines Workflows für das Branching die Qualität wichtiger Branches (z. B. main) zu gewährleisten, kannst du geschützte Branches mit erforderlichen Statusüberprüfungen und Pull Request-Überprüfungen verwenden. Weitere Informationen finden Sie unter Informationen zu geschützten Branches.
Verwenden von Git Large File Storage
Um die Leistung zu optimieren, begrenzt GitHub die Größe von Dateien, die in Repositorys zulässig sind. Weitere Informationen finden Sie unter Informationen zu großen Dateien auf GitHub.
Zum Nachverfolgen großer Dateien in einem Git-Repository empfehlen wir die Verwendung von Git Large File Storage (Git LFS). Weitere Informationen finden Sie unter Informationen zu Git Large File Storage.