Guide du contributeur Microsoft Docs - Vue d’ensembleMicrosoft Docs contributor guide overview

Bienvenue dans le guide du contributeur docs.microsoft.com (Docs) !Welcome to the docs.microsoft.com (Docs) Contributor Guide!

Plusieurs des ensembles de documents Microsoft sont open source et hébergés sur GitHub.Several of the Microsoft documentation sets are open source and hosted on GitHub. Certains ensembles de documents ne sont pas open source, mais plusieurs ont des référentiels publics dans lesquels vous pouvez suggérer des modifications via des requêtes de tirage.Not all document sets are completely open source but many have public-facing repos where you can make suggested changes via pull requests. 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 :This open source approach streamlines and improves communication between product engineers, content teams, and customers, and has other advantages:

  • Planification en open des dépôts open source pour obtenir du feedback permettant de savoir quels documents sont les plus demandés.Open source repos plan in the open to get feedback on what docs are most needed.
  • Révision en open des dépôts open source pour publier le contenu le plus utile lors de notre première publication.Open source repos review in the open to publish the most helpful content on our first release.
  • Mise à jour en open des dépôts open source pour simplifier l’amélioration en continu du contenu.Open source repos update in the open to make it easier to continuously improve the content.

L’expérience utilisateur sur docs.microsoft.com intègre directement les workflows GitHub pour être encore plus agréable.The user experience on docs.microsoft.com integrates GitHub workflows directly to make it even easier. Commencez par modifier le document que vous visualisez.Start by editing the document you are viewing. Apportez votre aide en révisant de nouvelles rubriques, ou signalez des problèmes de qualité.Or, help by reviewing new topics, or create quality issues.

Important

Tous les référentiels qui publient sur docs.microsoft.com ont adopté soit le Code de conduite Microsoft Open Source, soit le Code de conduite .NET Foundation.All repositories that publish to docs.microsoft.com have adopted the Microsoft Open Source Code of Conduct or the .NET Foundation Code of Conduct. Pour plus d’informations, consultez les questions fréquentes (FAQ) sur le code de conduite.For more information, see the Code of Conduct FAQ. Vous pouvez aussi envoyer vos questions ou vos commentaires à opencode@microsoft.com ou à conduct@dotnetfoundation.org.Or contact opencode@microsoft.com, or conduct@dotnetfoundation.org with any questions or comments.

Les corrections mineures ou les clarifications pour la documentation, ainsi que les exemples de code dans les référentiels publics, sont couverts par les Conditions d’utilisation du site web docs.microsoft.com.Minor corrections or clarifications to documentation and code examples in public repositories are covered by the docs.microsoft.com Terms of Use. Les nouveautés ou modifications significatives génèrent un commentaire dans la demande de tirage (pull request) qui vous invite à signer un contrat de licence de contribution en ligne si vous n’êtes pas un employé de Microsoft.New or significant changes generate a comment in the pull request, asking you to submit an online Contribution License Agreement (CLA) if you are not an employee of Microsoft. Vous devrez remplir le formulaire en ligne pour que nous puissions examiner ou accepter votre demande de tirage (pull request).We need you to complete the online form before we can review or accept your pull request.

Modifications rapides de documents existantsQuick edits to existing documents

Les modifications rapides permettent de rationaliser le processus de signalement et de correction de petites erreurs et omissions dans des documents.Quick edits streamline the process to report and fix small errors and omissions in documents. Malgré tous nos efforts, les documents que nous publions peuvent contenir de petites fautes de grammaire et d’orthographe.Despite all efforts, small grammar and spelling errors do make their way into our published documents. Même si vous pouvez signaler des problèmes et nous faire part d’erreurs, il est plus rapide et plus facile de créer une demande de tirage (pull request) pour résoudre un problème lorsque l’option est disponible.While you can create issues to report mistakes, it's faster and easier to create a pull request (PR) to fix the issue, when the option is available.

  1. Certaines pages de documents vous permettent de modifier le contenu directement dans le navigateur.Some docs pages allow you to edit content directly in the browser. Dans ce cas, un bouton Edit (Modifier) comme celui illustré ci-dessous s’affiche.If so, you'll see an Edit button like the one shown below. En cliquant sur le bouton Edit (Modifier) , vous accédez au fichier source sur GitHub.Clicking the Edit (or equivalently localized) button takes you to the source file on GitHub. Si le bouton Modifier est absent, cela signifie que la page de documentation ne peut pas être modifiée.If the Edit button is missing, that means the documentation page is not available to be changed.

    Emplacement du lien de modification

  2. Ensuite, cliquez sur l’icône crayon pour modifier l’article, comme indiqué.Next, click the pencil icon, to edit the article as shown. Si l’icône représentant un crayon est grisée, vous devez vous connecter à votre compte GitHub ou créer un compte.If the pencil icon is grayed out, you need to either log in to your GitHub account or create a new account.

    Emplacement de l’icône de crayon

  3. Effectuez vos modifications dans l’éditeur web.Make your changes in the web editor. Cliquez sur l’onglet Preview changes (Aperçu des modifications) pour vérifier la mise en forme de votre modification.Click the Preview changes tab to check the formatting of your change.

  4. Une fois vos modifications effectuées, faites défiler vers le bas de la page.Once you have made your changes, scroll to the bottom of the page. Entrez un titre et une description de vos modifications et cliquez sur Propose file change (Proposer une modification du fichier) comme indiqué sur la figure suivante :Enter a title and description for your changes and click Propose file change as shown in the following figure:

    Proposer une modification de fichier

  5. À présent que vous avez proposé votre modification, vous devez demander aux propriétaires du référentiel de « tirer (pull) » vos modifications dans leur référentiel.Now that you've proposed your change, you need to ask the owners of the repository to "pull" your changes into their repository. Pour cela, vous utilisez une « requête de tirage (pull) ».This is done using something called a "pull request". Lorsque vous avez cliqué sur Proposer une modification du fichier dans la figure ci-dessus, vous devriez avoir été dirigé vers une nouvelle page qui ressemble à la figure suivante :When you clicked on Propose file change in the figure above, you should have been taken to a new page that looks like the following figure:

    create pull request (créer une requête de tirage)

    Cliquez sur Créer une requête de tirage (pull) , entrez un titre (et une description si vous le voulez) pour la requête de tirage (pull), puis cliquez à nouveau sur Créer une requête de tirage (pull) .Click Create pull request, enter a title (and optionally a description) for the pull request, and then click Create pull request again. (Si vous débutez avec GitHub, consultez About Pull Requests (À propos des demandes de tirage) pour plus d’informations.)(If you are new to GitHub, see About Pull Requests for more information.)

  6. Et voilà !That's it! Les membres de l’équipe de contenu réviseront et fusionneront votre demande de tirage (PR).Content team members will review and merge your PR. Vous recevrez peut-être des commentaires avec des demandes des modification si vous avez effectué des modifications majeures.You may get some feedback requesting changes if you made larger changes.

L’interface utilisateur de modification GitHub est fonction de vos autorisations dans le référentiel.The GitHub editing UI responds to your permissions on the repository. Les images précédentes concernent les contributeurs qui n’ont pas d’autorisations d’écriture pour le référentiel cible.The preceding images are accurate for contributors that do not have write permissions to the target repository. GitHub crée automatiquement une duplication (fork) du référentiel cible dans votre compte.GitHub automatically creates a fork of the target repository in your account. Si vous bénéficiez d’un accès en écriture au dépôt cible, GitHub y crée une nouvelle branche.If you have write-access to the target repository, GitHub creates a new branch in the target repo. Le nom de la branche a la structure <GitHubId>-patch-n, avec votre identifiant GitHub et un identificateur numérique pour la branche du correctif.The branch name has the form <GitHubId>-patch-n using your GitHub ID, and a numeric identifier for the patch branch.

Nous utilisons des demandes de tirage pour toutes les modifications, même pour les contributeurs bénéficiant d’un accès en écriture.We use pull requests for all changes, even for contributors that have write-access. La branche master de la plupart des référentiels étant protégée, les mises à jour doivent êtres envoyées sous forme de demandes de tirage (PR).Most repositories have the master branch protected so that updates must be submitted as pull requests.

L’expérience de modification dans le navigateur est la mieux adaptée à des modifications mineures ou peu fréquentes.The in-browser editing experience is best for minor or infrequent changes. 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.If you make large contributions or use advanced Git features (such as branch management or advanced merge conflict resolution), you need to fork the repo and work locally.

Note

Si cette option est activée, vous pouvez modifier un article dans n’importe quelle langue et, selon le type de modification, voici ce qui se produit :If enabled, you can edit an article in any language and, based on the type of edit, the following will happen:

  1. toute modification linguistique approuvée permet aussi d’améliorer notre moteur de traduction automatiqueany linguistic change that is approved, will also help improve our Machine Translation engine
  2. toute modification qui change de manière significative le contenu de l’article sera gérée en interne pour envoyer une modification du même article en anglais, afin qu’elle soit traduite dans toutes les langues, si elle est approuvée.any edit that significantly modifies the content of the article will be handled internally to submit a change to the same article in English so that it will get localized in all languages if approved. Vos suggestions d’améliorations n’auront pas seulement un effet positif sur les articles dans votre langue, mais dans toutes les langues disponibles.Your suggested improvements will not only positively affect articles in your own language, but in all available languages.

Revue des demandes de tirage (PR) ouvertesReview open PRs

Vous pouvez lire les nouvelles rubriques avant leur publication en consultant les demandes de tirage (PR) actuellement ouvertes.You can read new topics before they are published by checking the currently open PRs. Les révisions suivent le processus de flux GitHub.Reviews follow the GitHub flow process. Vous pouvez voir les mises à jour proposées ou les nouveaux articles dans les référentiels publics.You can see proposed updates or new articles in public repositories. Révisez-les et ajoutez vos commentaires.Review them and add your comments. Parcourez l’un de nos référentiels de documents pour consulter les demandes de tirage (PR) ouvertes des zones qui vous intéressent.Look at any of our docs repositories, and check the open pull requests (PRs) for areas that interest you. Les commentaires de la communauté sur des mises à jour proposées aident toute la communauté virtuelle.Community feedback on proposed updates helps the entire community.

Signaler des problèmes de qualitéCreate quality issues

Nos documents font l’objet d’un travail continu.Our docs are a continuous work in progress. Les problèmes pertinents nous aident à concentrer nos efforts sur les priorités absolues de la communauté virtuelle.Good issues help us focus our efforts on the highest priorities for the community. Plus vous pouvez fournir de détails, plus la signalisation du problème sera utile.The more detail you can provide, the more helpful the issue. Dites-nous quelles informations vous avez cherchées.Tell us what information you sought. Dites-nous quels termes vous avez utilisés pour la recherche.Tell us the search terms you used. Si vous n’arrivez-pas à la lancer, dites-nous comment vous souhaitez commencer à explorer une technologie qui ne vous est pas familière.If you can't get started, tell us how you want to start exploring unfamiliar technology.

La plupart des pages de la documentation Microsoft contiennent une section Commentaires au bas de la page sur laquelle vous pouvez cliquer pour laisser des commentaires sur le produit ou des commentaires sur le contenu afin d’effectuer le suivi des problèmes spécifiques à cet article.Many of Microsoft's documentation pages have a Feedback section at the bottom of the page where you can click to leave Product feedback or Content feedback to track issues that are specific to that article.

Les problèmes permettent d’amorcer une conversation sur ce dont vous avez besoin.Issues start the conversation about what's needed. 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.The content team will respond to these issues with ideas for what we can add, and ask for your opinions. Lorsque nous créons un brouillon, nous vous demandons de réviser la demande de tirage (PR).When we create a draft, we'll ask you to review the PR.

Engagez-vous plusGet more involved

D’autres rubriques vous aident à commencer à contribuer de manière productive à Microsoft Docs. Elles expliquent les extensions utilisées sur la plateforme Microsoft Docs, ainsi que l’utilisation des référentiels GitHub et des outils Markdown.Other topics help you get started productively contributing to Microsoft Docs. They explain working with GitHub repositories, Markdown tools, and extensions used in the Microsoft Docs platform.