Contribuindo para a documentação powerShell

Obrigado pelo apoio da PowerShell!

O Guia do Colaborador é uma coleção de artigos que descrevem as ferramentas e processos que usamos para criar documentação na Microsoft. Alguns destes guias cobrem informações que são comuns a qualquer conjunto de documentação publicado para docs.microsoft.com . Alguns dos guias são específicos à forma como escrevemos documentação para o PowerShell.

Os artigos comuns estão disponíveis no nosso Guia Centralizado de Colaboradores. Os guias específicos do PowerShell estão disponíveis aqui.

Formas de contribuir

Há duas maneiras de contribuir. Ambas as contribuições são valiosas para nós.

  • Os problemas de arquivamento ajudam-nos a identificar problemas e lacunas na nossa documentação. Por vezes, as questões são difíceis de resolver, exigindo mais investigação e investigação. O processo de emissão permite-nos ter uma conversa sobre o problema e desenvolver uma resolução satisfatória.

  • Submeter um pedido de puxar para adicionar ou alterar conteúdo é um processo mais envolvido. As seguintes informações descrevem as ferramentas, processos e normas para a submissão de conteúdos à documentação.

Prepare-se para dar uma contribuição

Contribuir para a documentação precisa de uma conta do GitHub. Utilize a seguinte lista de verificação para instalar e configurar as ferramentas necessárias para fazer contribuições.

  1. Inscrever-se no GitHub
  2. Instalar ferramentas Git e Markdown
  3. Instale o Pacote de Autoria docs
  4. Instalar Posh-Git - não necessário mas recomendado
  5. Configurar um repositório Git no local
  6. Rever os fundamentos de Git e GitHub

Get started writing docs (Começar a escrever documentos)

Existem duas formas de contribuir com alterações à documentação:

  1. Edições rápidas para os docs existentes
    • Pequenas correções, fixação de erros ou pequenas adições
  2. Fluxo de trabalho completo GitHub para docs
    • grandes alterações, múltiplas versões, adicionar ou alterar imagens, ou contribuir com novos artigos

Leia também a secção de redação do Guia do Colaborador Centralizado. Outro recurso excelente é o Microsoft Writing Style Guide. O objetivo do Microsoft Writing Style Guide é ajudar editores, escritores técnicos, desenvolvedores, marketers e qualquer outra pessoa em TI a escrever melhores conteúdos.

As pequenas correções ou esclarecimentos à documentação e aos exemplos de código nos repositórios públicos estão abrangidos pelos termos de utilização docs.microsoft.com.

Utilize o fluxo de trabalho completo GitHub quando estiver a fazer alterações significativas. Se não é funcionário da Microsoft, alterações significativas geram um comentário no pedido de pull que lhe pede para submeter um Acordo de Licenciamento de Contribuição Online (CLA). Para podermos rever ou aceitar o seu pedido Pull, tem de preencher o formulário online.

Código de conduta

Todos os repositórios que publicam no docs.microsoft.com adotaram o Microsoft Open Source Code of Conduct (Código de Conduta do Microsoft Open Source) ou o .NET Foundation Code of Conduct (Código de Conduta do .NET Foundation). Para obter mais informações, veja Code of Conduct FAQ (FAQs do Código de Conduta).

Passos seguintes

Os seguintes artigos cobrem informações específicas da documentação powerShell. Onde há sobreposição com a orientação no Guia do Contribuinte centralizado, chamamos a atenção para a forma como essas regras diferem para o conteúdo powerShell.

Reveja os documentos seguintes:

Recursos adicionais