Condividi tramite

Contributi alla documentazione di PowerShell

Grazie per il supporto di PowerShell.

La Guida per i collaboratori è una raccolta di articoli che descrivono gli strumenti e i processi usati per creare la documentazione in Microsoft. Alcune di queste guide illustrano le informazioni comuni a qualsiasi set di documentazione pubblicato su learn.microsoft.com. Altre guide sono specifiche del modo in cui si scrive la documentazione per PowerShell.

Gli articoli comuni sono disponibili nella Guida per i collaboratori centralizzati. Le guide specifiche di PowerShell sono disponibili qui.

Come fornire il proprio contributo

Esistono due modi per contribuire. Entrambi i contributi sono preziosi per noi.

  • La presentazione dei problemi consente di identificare problemi e lacune nella documentazione. A volte i problemi sono difficili da risolvere, richiedendo più indagini e ricerche. Il processo di problema ci consente di avere una conversazione sul problema e sviluppare una risoluzione soddisfacente.

  • L'invio di una richiesta pull per aggiungere o modificare il contenuto è un processo più coinvolto. Le informazioni seguenti illustrano gli strumenti, i processi e gli standard per l'invio di contenuto alla documentazione.

Prepararsi a fornire un contributo

Per contribuire alla documentazione è necessario un account GitHub. Usare l'elenco di controllo seguente per installare e configurare gli strumenti necessari per fornire contributi.

  1. Iscriversi a GitHub
  2. Installare gli strumenti Git e Markdown
  3. Installare il Docs Authoring Pack
  4. Installare Posh-Git : non obbligatorio ma consigliato
  5. Configurare un repository Git locale
  6. Esaminare i concetti fondamentali di Git e GitHub

Introduzione alla scrittura della documentazione

Esistono due modi per contribuire alle modifiche alla documentazione:

  1. Modifiche rapide alla documentazione esistente - Correzioni secondarie, correzione di errori di digitazione o piccole aggiunte
  2. Flusso di lavoro GitHub completo per la documentazione : modifiche di grandi dimensioni, più versioni, aggiunta o modifica di immagini o aggiunta di nuovi articoli

Leggere anche la sezione Nozioni di scrittura essenziali della Guida centralizzata per i collaboratori. Un'altra risorsa eccellente è la Guida di stile di scrittura Microsoft.

Correzioni o chiarimenti secondari alla documentazione e agli esempi di codice nei repository pubblici sono coperti dalle condizioni per l'utilizzo learn.microsoft.com.

Usare il flusso di lavoro GitHub completo quando si apportano modifiche significative. Se non sei un dipendente di Microsoft, il nostro sistema di convalida delle PR aggiunge un commento alla richiesta pull chiedendoti di firmare online il Contratto di licenza per contributi (CLA). È necessario completare questo passaggio prima di poter esaminare o accettare la richiesta pull. La firma dell'Accordo di Licenza è necessaria solo la prima volta che si sottopone una PR nel repository. Potrebbe essere richiesto di firmare il contratto di licenza per ogni volta che si contribuisce a un nuovo repository.

Codice di condotta

Tutti i repository che pubblicano in Microsoft Learn rispettano il codice di comportamento microsoft open source o il codice di comportamento di .NET Foundation. Per altre informazioni, vedere domande frequenti sul codice di comportamento.

Passaggi successivi

Gli articoli seguenti illustrano le informazioni specifiche della documentazione di PowerShell. In caso di sovrapposizione con le linee guida contenute nella Guida per i collaboratori centralizzati, viene illustrato il modo in cui queste regole differiscono per il contenuto di PowerShell.

Vedere i documenti seguenti:

Risorse aggiuntive

  • Last updated on