Partilhar via

Contribuindo para a documentação do PowerShell

Obrigado pelo seu apoio ao 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 abrangem informações comuns a qualquer conjunto de documentação publicado no learn.microsoft.com. Outros guias são específicos para como escrevemos documentação para o PowerShell.

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

Formas de contribuir

Existem duas formas de contribuir. Ambas as contribuições são valiosas para nós.

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

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

Prepare-se para fazer uma contribuição

Para contribuir com a documentação, é necessária uma conta no GitHub. Use a lista de verificação a seguir para instalar e configurar as ferramentas necessárias para fazer contribuições.

  1. Inscreva-se no GitHub
  2. Instalar ferramentas Git e Markdown
  3. Instalar o Docs Authoring Pack
  4. Instalar o Posh-Git - não é necessário, mas recomendado
  5. Configurar um repositório Git local
  6. Revise os fundamentos do Git e do GitHub

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

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

  1. Edições rápidas em documentos existentes - Pequenas correções, 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 contribuição de novos artigos

Leia também a seção Fundamentos da escrita do Guia do Colaborador centralizado. Outro excelente recurso é o Microsoft Writing Style Guide.

Pequenas correções ou esclarecimentos à documentação e exemplos de código em repositórios públicos são cobertos pelos learn.microsoft.com Termos de Uso.

Use o fluxo de trabalho completo do GitHub quando estiver fazendo alterações significativas. Se você não for um funcionário da Microsoft, nosso sistema de validação de RP adicionará um comentário à solicitação pull solicitando que você assine o Contrato de Licença de Contribuição (CLA) online. Deve concluir este passo antes de podermos rever ou aceitar o seu pull request. A assinatura do CLA só é necessária na primeira vez que você enviar um 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 que publicam no Microsoft Learn aderem ao Código de Conduta de Código Aberto da Microsoft 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óximos passos

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

Reveja os documentos seguintes:

Recursos adicionais

  • Last updated on