Partager via

Contribution à la documentation de PowerShell

Merci d’avoir pris en charge PowerShell !

Le Guide du contributeur est une collection d’articles qui décrivent les outils et processus que nous utilisons pour créer de la documentation chez Microsoft. Certains de ces guides couvrent les informations communes à n’importe quel ensemble de documentation publié sur learn.microsoft.com. D’autres guides sont spécifiques à la façon dont nous écrivons de la documentation pour PowerShell.

Les articles communs sont disponibles dans notre Guide centralisé du contributeur. Les guides spécifiques à PowerShell sont disponibles ici.

Méthodes de contribution

Il existe deux façons de contribuer. Les deux contributions sont précieuses pour nous.

  • Les problèmes de dépôt nous aident à identifier les problèmes et les lacunes dans notre documentation. Parfois, les problèmes sont difficiles à résoudre, nécessitant plus d’investigation et de recherche. Le processus de problème nous permet d’avoir une conversation sur le problème et de développer une résolution satisfaisante.

  • Soumettre une pull request pour ajouter ou modifier du contenu est un processus plus complexe. Les informations suivantes décrivent les outils, les processus et les normes pour soumettre du contenu à la documentation.

Préparez-vous à apporter une contribution

La contribution à la documentation nécessite un compte GitHub. Utilisez la liste de contrôle suivante pour installer et configurer les outils dont vous avez besoin pour apporter des contributions.

  1. S’inscrire à GitHub
  2. Installer les outils Git et Markdown
  3. Installer le pack Docs Authoring
  4. Installer Posh-Git - non obligatoire mais recommandé
  5. Configurer un dépôt Git local
  6. Passer en revue les principes fondamentaux de Git et GitHub

Commencer à écrire de la documentation

Il existe deux façons de contribuer aux modifications apportées à la documentation :

  1. Modifications rapides des documents existants - Corrections mineures, corrections de fautes de frappe ou petits ajouts
  2. Flux de travail GitHub complet pour les documents : modifications volumineuses , plusieurs versions, ajout ou modification d’images, ou contribution de nouveaux articles

Lisez également la section Informations essentielles sur l’écriture du Guide centralisé du contributeur. Une autre excellente ressource est le Guide de style d’écriture Microsoft.

Les corrections mineures ou les clarifications apportées à la documentation et aux exemples de code dans les référentiels publics sont couvertes par les learn.microsoft.com conditions d’utilisation.

Utilisez le flux de travail GitHub complet lorsque vous apportez des modifications importantes. Si vous n’êtes pas un employé de Microsoft, notre système de validation de demande de tirage ajoute un commentaire à la demande de tirage vous demandant de signer le contrat de licence de contribution en ligne (CLA). Vous devez effectuer cette étape avant que nous puissions examiner ou accepter votre pull request. La signature du CLA n'est requise que la première fois que vous soumettez une pull request dans le dépôt. Vous serez peut-être invité à signer le CLA pour chaque fois que vous contribuez à un nouveau référentiel.

Code de conduite

Tous les référentiels qui publient sur Microsoft Learn adhèrent au Code de conduite Microsoft Open Source ou au Code de conduite .NET Foundation. Pour plus d’informations, consultez le FAQ sur le Code de conduite.

Étapes suivantes

Les articles suivants couvrent des informations spécifiques à la documentation PowerShell. Lorsqu'il y a un chevauchement avec les directives du Guide centralisé des contributeurs, nous précisons en quoi ces règles diffèrent pour le contenu PowerShell.

Consultez les documents suivants :

Ressources supplémentaires