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 par défaut de santé de la communauté sont un ensemble de fichiers prédéfinis qui fournissent des recommandations et des modèles pour maintenir un projet open source sain et collaboratif. Ces fichiers vous aident à automatiser et à standardiser différents aspects du développement de votre projet et des interactions avec la communauté, en favorisant la transparence, les bonnes pratiques et la collaboration.

Vous pouvez ajouter des fichiers d’intégrité de la communauté par défaut à un dépôt public appelé .github et GitHub utilisera et affiche les fichiers par défaut pour tout dépôt 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 utilisera le fichier par défaut du référentiel .github, en respectant le même ordre de priorité.

Par exemple, toute personne qui crée un problème ou une pull request dans un référentiel qui n’a pas son propre fichier CONTRIBUTING.md voit un lien vers le fichier CONTRIBUTING.md par défaut à partir du répertoire .github. Toutefois, si un référentiel contient des fichiers dans son propre dossier .github/ISSUE_TEMPLATE, tels que des modèles d’issues ou un fichier _config.yml, aucun contenu du .github/ISSUE_TEMPLATE par défaut ne sera utilisé. Cela permet aux responsables du référentiel de remplacer les fichiers par défaut par des modèles ou du contenu spécifiques, au niveau de chaque référentiel.

Le stockage des fichiers dans le référentiel .github permet de modifier les paramètres par défaut dans un seul et même emplacement. En outre, ils n’apparaîtront ni dans l’explorateur de fichiers ni dans l’historique Git des référentiels individuels, et ne sont pas inclus dans leurs clones, packages ou téléchargements.

À propos des stratégies de sécurité

En rendant les instructions de signalement des vulnérabilités de sécurité clairement disponibles, vous permettez à vos utilisateurs de signaler facilement les vulnérabilités de sécurité qu’ils trouvent dans votre dépôt en utilisant votre canal de communication préféré.

Pour obtenir un exemple de fichier SECURITY.md réel, consultez https://github.com/electron/electron/blob/main/SECURITY.md.

Types de fichiers pris en charge

Vous pouvez créer des paramètres par défaut dans votre organisation ou votre compte personnel pour les fichiers de santé de la communauté suivants :

Fichier d’intégrité de la communauté	Description
CONTRIBUTING.md	Un fichier CONTRIBUTING explique comment les personnes peuvent 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égories de discussion personnalisent les modèles mis à disposition des membres de la communauté lorsqu’ils ouvrent de nouvelles discussions dans votre référentiel. Pour plus d’informations, consultez « Créer des formulaires de catégorie de discussion ».
GOVERNANCE.md	Un fichier GOVERNANCE informe sur la manière dont votre projet est gouverné. 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 d’issues et de pull requests permettent de personnaliser et de standardiser les informations que vous souhaitez que les contributeurs incluent lorsqu’ils ouvrent des issues et des pull requests dans votre référentiel. Pour plus d’informations, consultez « À propos des modèles de problème et de demande de tirage ». Si un modèle d’issue définit une étiquette, cette étiquette doit être créée dans le référentiel .github ainsi que dans tous les référentiels où le modèle sera utilisé.
SECURITY.md	Un fichier SECURITY fournit des instructions sur la manière de signaler une vulnérabilité de sécurité dans votre projet, ainsi qu’une description qui contient un lien vers ce fichier. Pour plus d’informations, consultez « Ajout d’une stratégie de sécurité à votre dépôt ».
SUPPORT.md	Un fichier SUPPORT informe sur les différentes manières d’obtenir de l’aide pour 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 et 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 référentiel est défini sur Public. Un dépôt pour les fichiers par défaut ne peut pas être privé.

6. Réglez l’option Ajouter README sur Actif.

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 d’issues et leur fichier de configuration doivent se trouver dans un dossier nommé .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 ».