Compartilhar via

Contribuindo para a documentação do PowerShell

Obrigado pelo apoio do PowerShell!

O Guia do Colaborador é uma coleção de artigos que descrevem as ferramentas e os processos que usamos para criar documentação na Microsoft. Alguns desses guias abordam informações comuns a qualquer conjunto de documentação publicado em learn.microsoft.com. Outros guias são específicos de como escrevemos a documentação para o PowerShell.

Os artigos comuns estão disponíveis em nosso Guia centralizado do Colaborador. Os guias específicos do PowerShell estão disponíveis aqui.

Formas de contribuição

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

  • Relatar problemas nos ajuda a identificar questões e lacunas em nossa documentação. Às vezes, as questões são difíceis de resolver, exigindo mais investigação e pesquisa. O processo de problema nos permite ter uma conversa sobre o problema e desenvolver uma resolução satisfatória.

  • Enviar uma solicitação pull para adicionar ou alterar o conteúdo é um processo mais envolvido. As informações a seguir descrevem as ferramentas, os processos e os padrões para enviar conteúdo à documentação.

Preparar-se para fazer uma contribuição

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

  1. Inscrever-se no GitHub
  2. Instalar as ferramentas Git e Markdown
  3. Instalar o Pacote de Autoria do Docs
  4. Instalar o Posh-Git – não necessário, mas recomendado
  5. Configurar um repositório Git local
  6. Examinar os conceitos básicos do Git e do GitHub

Comece a colaborar para a documentação

Há duas maneiras de contribuir com alterações na documentação:

  1. Edições rápidas para documentos existentes – correções secundárias, correção de erros de digitação ou pequenas adições
  2. Fluxo de trabalho completo do GitHub para documentos – grandes alterações, várias versões, adição ou alteração de imagens ou contribuindo com novos artigos

Além disso, leia a seção Elementos Essenciais da Escrita do Guia do Colaborador Centralizado. Outro recurso excelente é o Guia de Estilo de Escrita da Microsoft.

Correções secundárias ou esclarecimentos sobre documentação e exemplos de código em repositórios públicos são abordados pelos Termos de Uso do learn.microsoft.com.

Use o fluxo de trabalho completo do GitHub quando você estiver fazendo alterações significativas. Se você não for um funcionário da Microsoft, nosso sistema de validação de PR adicionará um comentário à solicitação de pull solicitando que você assine o CLA (Contrato de Licenciamento de Contribuição) online. Você deve concluir esta etapa antes que possamos examinar ou aceitar sua solicitação de pull. A assinatura do CLA é necessária apenas na primeira vez que você envia uma PR no repositório. Você pode ser solicitado a assinar o CLA para cada vez que contribuir para um novo repositório.

Código de conduta

Todos os repositórios publicados no Microsoft Learn aderem ao Código de Conduta do Microsoft Open Source ou ao Código de Conduta do .NET Foundation. Para obter mais informações, consulte as perguntas frequentes sobre o Código de Conduta.

Próximas etapas

Os artigos a seguir abordam informações específicas da documentação do PowerShell. Quando há sobreposição com as diretrizes no Guia centralizado do Colaborador, explicamos como essas regras diferem para o conteúdo do PowerShell.

Examine os seguintes documentos:

Recursos adicionais

  • Last updated on