Création d’un fichier d’intégrité de la communauté par défaut

À propos des fichiers d’intégrité de la communauté par défaut

Les fichiers d’intégrité de la communauté par défaut sont un ensemble de fichiers prédéfinis qui fournissent des conseils et des modèles permettant de maintenir un projet open source sain et collaboratif. Ces fichiers vous aident à automatiser et à standardiser divers aspects du développement de votre projet et de l’interaction avec la communauté, favorisant ainsi la transparence, les bonnes pratiques et la collaboration.

Vous pouvez ajouter des fichiers d’intégrité de la communauté par défaut à un référentiel public appelé .github et GitHub Enterprise Cloud utilisera et affichera les fichiers par défaut pour tout référentiel appartenant au compte qui n’a pas son propre fichier de ce type dans l’ordre suivant :

• Le dossier .github
• La racine du dépôt
• Le dossier docs

Si aucun fichier correspondant n’est trouvé dans le référentiel actuel, GitHub Enterprise Cloud utilisera le fichier par défaut du référentiel .github, en suivant le même ordre de priorité.

Par exemple, toute personne qui crée un problème ou une demande de tirage dans un référentiel qui n’a pas son propre fichier CONTRIBUTING.md verra un lien vers le CONTRIBUTING.md par défaut du référentiel .github. Toutefois, si un référentiel possède des fichiers dans son propre dossier .github/ISSUE_TEMPLATE, tels que des modèles de questions ou un fichier _config.yml, aucun contenu du dossier .github/ISSUE_TEMPLATE par défaut ne sera utilisé. Cela permet aux responsables des référentiels de remplacer les fichiers par défaut par des modèles ou des contenus spécifiques pour chaque référentiel.

Le stockage des fichiers dans le référentiel .github permet d’apporter des modifications aux fichiers par défaut en un seul endroit. De plus, ils n’apparaîtront pas dans le navigateur de fichiers ou l’historique Git des référentiels individuels, et ne sont pas inclus dans leurs clones, packages ou téléchargements.

En tant que responsable de dépôt, vous pouvez utiliser la check-list des standards de communauté afin de déterminer si votre projet répond aux standards de communauté recommandés pour aider les gens à utiliser votre projet et à y contribuer. Pour plus d’informations, consultez « À propos des profils de communauté des dépôts publics ».

Types de fichiers pris en charge

Vous pouvez créer des valeurs par défaut dans votre organisation ou votre compte personnel pour les fichiers d’intégrité de la communauté suivants :

Fichier d’intégrité de la communauté	Description
CODE_OF_CONDUCT.md	Un fichier CODE_OF_CONDUCT définit les normes permettant de s’engager dans une communauté. Pour plus d’informations, consultez « Ajouter un code de conduite à votre projet ».
CONTRIBUTING.md	Un fichier CONTRIBUTING communique la façon dont les personnes doivent contribuer à votre projet. Pour plus d’informations, consultez « Définition de recommandations pour les contributeurs de dépôt ».
Formulaires de catégorie de discussion	Les formulaires de catégorie de discussion personnalisent les modèles disponibles pour les membres de la communauté à utiliser lorsqu’ils ouvrent de nouvelles discussions dans votre dépôt. Pour plus d’informations, consultez « Créer des formulaires de catégorie de discussion ».
FUNDING.yml	Un fichier FUNDING affiche un bouton de sponsor dans votre dépôt pour accroître la visibilité des options de financement pour votre projet open source. Pour plus d’informations, consultez « Affichage d’un bouton Sponsor dans votre dépôt ».
GOVERNANCE.md	Un fichier GOVERNANCE permet aux utilisateurs de savoir comment votre projet est régi. Par exemple, il peut parler des rôles du projet et de la façon dont les décisions sont prises.
Modèles de problème et de demande de tirage et config.yml	Les modèles de demande de tirage et de problème personnalisent et normalisent les informations que vous souhaitez inclure quand ils ouvrent des problèmes et des demandes de tirage dans votre référentiel. Pour plus d’informations, consultez « À propos des modèles de problème et de demande de tirage ».
SECURITY.md	Un fichier SECURITY fournit des instructions pour signaler une faille de sécurité dans votre projet et une description qui crée un lien hypertexte vers le fichier. Pour plus d’informations, consultez « Ajout d’une stratégie de sécurité à votre dépôt ».
SUPPORT.md	Un fichier SUPPORT permet aux utilisateurs de savoir comment obtenir de l’aide sur votre projet. Pour plus d’informations, consultez « Ajout de ressources de support à votre projet ».

Vous ne pouvez pas créer de fichier de licence par défaut. Vous devez ajouter les fichiers de licence à des dépôts individuels pour qu’ils soient inclus quand un projet est cloné, packagé ou téléchargé.

Création d’un dépôt pour les fichiers par défaut

1. Dans le coin supérieur droit de n’importe quelle page, sélectionnez sur , puis cliquez sur Nouveau référentiel.

   

2. Utilisez le menu déroulant Propriétaire, puis sélectionnez l’organisation ou le compte personnel pour lequel vous souhaitez créer les fichiers par défaut.

   

3. Dans le champ « Nom du dépôt », tapez .github.

4. Dans le champ « Description », vous pouvez taper une description.

5. Vérifiez que l’état du dépôt est défini sur Public. Un dépôt pour les fichiers par défaut ne peut pas être privé.

6. Sélectionnez Initialize this repository with a README (Initialiser ce dépôt à l’aide d’un fichier LISEZMOI).

7. Cliquez sur Créer le dépôt.

8. Dans le dépôt, créez l’un des fichiers d’intégrité de la communauté pris en charge. Les modèles de problème et leur fichier config doivent se trouver dans un dossier appelé .github/ISSUE_TEMPLATE. Tous les autres fichiers pris en charge peuvent se trouver à la racine du dépôt, dans le dossier .github ou dans le dossier docs. Pour plus d’informations, consultez « Création de fichiers ».