Créer un fichier README
Pour faciliter la compréhension et la navigation dans votre projet, nous vous recommandons de créer un fichier README pour chaque référentiel.
Vous pouvez ajouter un fichier README à un référentiel pour communiquer des informations importantes sur votre projet. Un fichier README, ainsi qu’une licence de dépôt, fichier de citation, des recommandations de contribution et un code de conduite, pour communiquer les attentes de votre projet et vous aider à gérer les contributions. Pour plus d’informations, consultez « À propos des README ».
Privilégier la création de branches à la duplication
Pour faciliter la collaboration, nous recommandons que les collaborateurs réguliers travaillent à partir d’un seul référentiel, en créant des demandes de tirage entre les branches plutôt qu’entre les référentiels. La duplication est mieux adaptée pour accepter des contributions de personnes qui ne sont pas affiliées à un projet, par exemple des contributeurs open source.
Pour maintenir la qualité des branches importantes, notamment main, lors de l’utilisation d’un workflow de branchement, vous pouvez utiliser des branches protégées avec des vérifications d’état requises et des révisions de demande de tirage. Pour plus d’informations, consultez « À propos des branches protégées ».
Utiliser Stockage Fichiers volumineux Git
Pour optimiser les performances, GitHub.com limite la taille des fichiers autorisés dans les référentiels. Pour plus d’informations, consultez « À propos des fichiers volumineux sur GitHub ».
Pour suivre des fichiers volumineux dans un référentiel Git, nous vous recommandons d’utiliser Stockage Fichiers volumineux Git (Git LFS). Pour plus d’informations, consultez « À propos du stockage de fichiers Git volumineux ».