La documentation GitHub est open source. Tout le monde peut contribuer à la documentation dans le dépôt docs public : https://github.com/github/docs. Les personnes travaillant chez GitHub travaillent sur la documentation dans une copie de ce dépôt appelée docs-internal. Les deux dépôts sont automatiquement synchronisés pour les maintenir à jour avec les modifications fusionnées dans la branche main de l’un ou l’autre dépôt. Par souci de simplicité, nous allons faire référence au « dépôt de documentation » dans les articles sur la contribution à GitHub Docs.
Le dépôt de documentation est l’endroit idéal pour discuter et collaborer sur la documentation qui est publiée ici sur docs.github.com.
Problèmes
Les problèmes sont utilisés pour suivre les tâches pour lesquelles des contributeurs peuvent apporter une aide. Si un problème a une étiquette triage, cela signifie que nous ne l’avons pas encore examiné, et vous ne devez pas commencer à travailler dessus.
Si vous avez trouvé quelque chose dans le contenu de la documentation ou sur le site web docs.github.com qui doit être mis à jour, effectuez une recherche dans les problèmes ouverts pour voir si quelqu’un d’autre a signalé la même chose. S’il s’agit d’une nouveauté, ouvrez un problème en utilisant un modèle. Nous allons utiliser le problème pour avoir une conversation sur le problème dont vous aimeriez qu’il soit résolu.
Note
Les personnes travaillant chez GitHub doivent ouvrir les problèmes dans le référentiel docs-content privé.
Demandes de tirage
Une demande de tirage est un moyen de suggérer des modifications dans notre dépôt. Quand nous fusionnons ces modifications, elles sont déployées sur le site actif dans les 24 heures.
Nous ne pouvons pas accepter de contributions à la documentation de référence de l’API REST. Si vous détectez une inexactitude dans la documentation de référence de l’API REST, ouvrez un problème dans le dépôt rest-api-description.
Nous documentons uniquement GitHub produits, fonctionnalités, outils et extensions. Nous pouvons mentionner ou inclure des liens vers des outils tiers pour illustrer le fonctionnement d’une fonctionnalité, mais nous n’acceptons pas les demandes de tirage pour documenter les outils ou les intégrations tiers, sauf s’ils ont été codéveloppés avec GitHub.
Révision de vos propres demandes de tirage
Vous devez toujours d’abord réviser votre propre demande de tirage avant de la marquer comme prête à être révisée par d’autres personnes.
Pour les modifications de contenu, veillez à :
- Vérifier que les modifications répondent à l’expérience utilisateur et aux objectifs décrits dans le plan de conception du contenu (le cas échéant).
- Réviser l’exactitude technique du contenu.
- Vérifiez la grammaire, l'orthographe et le respect de l'Guide de style.
- Vérifier que le texte de votre demande de tirage sera facile à traduire. Pour plus d’informations, consultez « Rédaction de contenu à traduire ».
- Vérifier les instructions Liquid nouvelles ou mises à jour pour vous assurer que le versioning est correct. Pour plus d’informations, consultez « Documentation sur le contrôle de version ».
- Vérifiez l’aperçu des pages que vous avez modifiées. Un aperçu est généré automatiquement après l’envoi d’une demande de tirage et des liens sont ajoutés à la demande de tirage. L’aperçu prend parfois plusieurs minutes avant d’être visible. Vérifiez que tout est rendu comme attendu. La vérification de l’aperçu vous aidera à identifier des problèmes comme les fautes de frappe, du contenu qui ne suit pas le guide de style ou du contenu qui ne s’affiche pas en raison de problèmes de versioning. Veillez à vérifier les listes et les tableaux dans le rendu de la sortie, qui peuvent parfois avoir des problèmes difficiles à identifier dans le Markdown.
- Si des contrôles échouent dans votre demande de tirage, résolvez-les jusqu’à ce qu’ils réussissent tous.
Support
Nous sommes une petite équipe qui travaille dur pour répondre aux demandes en termes de documentation d’un produit en constante évolution. Malheureusement, nous ne pouvons tout simplement pas vous aider sur des questions de support dans ce dépôt. Si vous rencontrez un problème avec GitHub sans rapport avec notre documentation, contactez directement le support GitHub. Les problèmes ou les demandes de tirage (pull request) ouverts dans le dépôt de documentation demandant du support recevront des informations sur la façon de contacter le support GitHub, puis ils seront fermés et verrouillés.
Si vous rencontrez des problèmes avec votre compte GitHub, contactez le support.
Translations
Ce site web est internationalisé et disponible en plusieurs langues. Le contenu source de ce dépôt est écrit en anglais. Nous automatisons les traductions via un processus interne, en collaboration avec des traducteurs professionnels pour localiser le contenu qui est en anglais.
Si vous détectez une erreur de traduction, ouvrez un problème avec les détails.
Nous n’acceptons pas actuellement les demandes de tirage pour le contenu traduit.
Politique du Site
Les stratégies de site de GitHub sont également publiées sur docs.github.com.
Si vous trouvez une faute de frappe dans la section des stratégies de site, vous pouvez ouvrir une demande de tirage pour la corriger. Pour toute autre chose, consultez « Contribution » dans le dépôt site-policy.