Vue d’ensemble du guide du contributeur à la documentation Microsoft Learn
Bienvenue dans le guide du contributeur à la documentation Microsoft Learn !
Partager votre expertise avec d’autres personnes sur Microsoft Learn aide tout le monde à en faire plus. Utilisez les informations de ce guide pour publier un nouvel article sur Microsoft Learn ou effectuer des mises à jour d’un article publié existant.
Plusieurs des ensembles de documents Microsoft sont open source et hébergés sur GitHub. Certains ensembles de documents ne sont pas entièrement open source. Cependant, nombre d’entre eux comportent des référentiels publics dans lesquels il est possible de suggérer des modifications au moyen de demandes de tirage (pull request). Cette approche open source simplifie et améliore la communication entre les ingénieurs produit, les équipes de contenu et les clients, et offre d’autres avantages :
- Planification en open des référentiels open source pour savoir quels sont les documents les plus demandés.
- Révision en open des référentiels open source pour publier le contenu le plus utile lors de notre première publication.
- Mise à jour en open des référentiels open source pour simplifier l’amélioration en continu du contenu.
L’expérience utilisateur sur Microsoft Learn intègre directement les flux de travail GitHub pour le rendre encore plus facile. Commencez par modifier le document que vous visualisez. Apportez votre aide en révisant de nouvelles rubriques ou en signalant des problèmes de qualité.
Important
Tous les dépôts qui publient sur Microsoft Learn ont adopté le Code de conduite Open Source Microsoft ou le Code de conduite .NET Foundation. Pour plus d’informations, consultez les questions fréquentes (FAQ) sur le code de conduite. Envoyez vos questions ou vos commentaires à opencode@microsoft.com ou à conduct@dotnetfoundation.org.
Les learn.microsoft.com conditions d’utilisation couvrent les corrections mineures ou les clarifications apportées à la documentation et aux exemples de code dans les dépôts publics. Les nouveautés et les modifications significatives génèrent un commentaire dans la demande de tirage qui vous invite à signer un contrat de licence de contribution en ligne si vous n’êtes pas un employé de Microsoft. Vous devez remplir le formulaire en ligne pour que nous puissions examiner ou accepter votre demande de tirage.
Modifications rapides dans la documentation
Les modifications rapides permettent de rationaliser le processus de signalement et de correction de petites erreurs et omissions dans des documents. Malgré tous nos efforts, les documents que nous publions peuvent contenir de petites fautes de grammaire et d’orthographe. Même si vous pouvez signaler des problèmes pour nous faire part d’erreurs, il est plus rapide et plus facile de créer une demande de tirage pour résoudre un problème lorsque l’option est disponible.
Certaines pages de documents vous permettent de modifier le contenu directement dans le navigateur. Dans ce cas, un bouton Edit (Modifier) comme celui illustré ci-dessous s’affiche. En sélectionnant le bouton Modifier, vous accédez au fichier source sur GitHub.
Si le bouton Modifier n’est pas présent, cela signifie que le contenu n’est pas ouvert aux contributions publiques. Certaines pages sont générées (par exemple, dans la documentation incluse dans le code) et doivent être modifiées dans le projet auquel elles appartiennent.
Sélectionnez l’icône en forme de crayon pour modifier l’article. Si l’icône représentant un crayon est grisée, vous devez vous connecter à votre compte GitHub ou créer un compte.
Modifiez le fichier dans l’éditeur web. Sélectionnez l’onglet Aperçu pour vérifier la mise en forme de vos modifications.
Lorsque vous avez terminé la modification, faites défiler la page jusqu’en bas. Dans la zone Proposer des modifications, entrez un titre et éventuellement une description de vos modifications. Le titre sera la première ligne du message de commit. Sélectionnez Proposer des modifications pour créer une branche dans votre duplication et valider vos modifications :
À présent que vous avez proposé et commité vos modifications, vous devez demander aux propriétaires du dépôt de les « tirer » (pull) dans leur dépôt. Utilisez pour cela une « demande de tirage » (pull request). Lorsque vous sélectionnez Proposer des modifications, une nouvelle page s’affiche :
Sélectionnez Create pull request. Entrez ensuite un titre et une description pour la demande de tirage, puis sélectionnez Créer une demande de tirage. Si vous débutez avec GitHub, consultez À propos des demandes de tirage pour plus d’informations.
Et voilà ! Les membres de l’équipe de contenu réviseront votre demande de tirage et la fusionneront lorsqu’ils l’auront approuvée. Il est possible que vous receviez des suggestions de modifications.
L’interface utilisateur de modification GitHub est fonction de vos autorisations dans le référentiel. Les images précédentes concernent les contributeurs qui ne disposent pas d’autorisations d’écriture sur le dépôt cible. GitHub crée automatiquement une duplication (fork) du référentiel cible dans votre compte. Le nom de la duplication nouvellement créée a le formulaire GitHubUsername/RepositoryName par défaut. Si vous bénéficiez d’un accès en écriture au dépôt cible, comme votre duplication, GitHub y crée une nouvelle branche. Le nom de la branche a la forme par défaut patch-n, avec un identificateur numérique pour la branche du correctif.
Nous utilisons des demandes de tirage pour toutes les modifications, même lorsque les contributeurs bénéficient d’un accès en écriture. La plupart des référentiels protègent la branche par défaut, c’est pourquoi les mises à jour doivent être envoyées sous forme de demandes de tirage.
L’expérience de modification dans le navigateur est la mieux adaptée à des modifications mineures ou peu fréquentes. Si vous effectuez des contributions importantes ou que vous utilisez des fonctionnalités avancées de Git (comme la gestion des branches ou la résolution des conflits de fusion avancés), vous devez dupliquer le dépôt et travailler localement.
Notes
Le plus souvent, la documentation localisée ne permet pas d’apporter des modifications ni de formuler des commentaires par le biais de GitHub. Pour fournir des commentaires sur le contenu localisé, utilisez le https://aka.ms/provide-feedback formulaire.
Revue des demandes de tirage (PR) ouvertes
Vous pouvez lire les nouvelles rubriques avant leur publication en consultant la file d’attente des demandes de tirage ouvertes. Les révisions suivent le processus de flux GitHub. Vous pouvez voir les mises à jour proposées ou les nouveaux articles dans les référentiels publics. Révisez-les et ajoutez vos commentaires. Examinez l’un de nos dépôts Microsoft Learn et vérifiez les demandes de tirage ouvertes pour les domaines qui vous intéressent. Les commentaires de la communauté sur des mises à jour proposées aident toute la communauté virtuelle.
Signaler des problèmes de qualité
Nos documents font l’objet d’un travail continu. Les problèmes pertinents nous aident à concentrer nos efforts sur les priorités absolues de la communauté virtuelle. Plus vous pouvez fournir de détails, plus la signalisation du problème sera utile. Dites-nous quelles informations vous avez cherchées. Dites-nous quels termes vous avez utilisés pour la recherche. Si vous n’arrivez-pas à la lancer, dites-nous comment vous souhaitez commencer à explorer une technologie qui ne vous est pas familière.
La plupart des pages de la documentation Microsoft contiennent une section Commentaires tout en bas. Dans cette section, vous pouvez choisir de laisser des commentaires sur le produit ou des commentaires sur le contenu afin de suivre les problèmes propres à l’article en question.
Les problèmes permettent d’amorcer une conversation sur ce dont vous avez besoin. L’équipe chargée du contenu réagira aux problèmes signalés avec des idées concernant ce que nous pouvons ajouter et vous demandera votre avis. Lorsque nous créons un brouillon, nous vous demandons de réviser la demande de tirage (PR).
Engagez-vous plus
D’autres rubriques de ce guide vous aident à commencer à contribuer de manière productive à Microsoft Learn. Ils expliquent comment utiliser des référentiels GitHub, des outils Markdown et des extensions utilisés dans le contenu Microsoft Learn.