Como enviar solicitações de pull

Para fazer alterações no conteúdo, envie uma solicitação de pull (PR) da sua ramificação. Um pull request deve ser revisado antes de ser mesclado. Para obter melhores resultados, examine a lista de verificação editorial antes de enviar sua solicitação de pull.

Usando ramificações do Git

O branch padrão para PowerShell-Docs é o branch main. As alterações feitas em branches de trabalho são mescladas no branch main antes de serem publicadas. O ramo main é mesclado no ramo live todos os dias úteis às 15h (horário do Pacífico). O ramo live contém o conteúdo que é publicado em learn.microsoft.com.

Antes de iniciar as alterações, crie um ramo de trabalho em sua cópia local do repositório PowerShell-Docs. Ao trabalhar localmente, certifique-se de sincronizar seu repositório local antes de criar seu ramo de trabalho. O ramo de trabalho deve ser criado a partir de uma cópia datada de up-todo ramo main.

Todas as solicitações de pull devem ser direcionadas ao main branch. Não envie alterações ao live branch. As alterações feitas no main branch são mescladas no live, substituindo as alterações feitas em live.

Fazer com que o processo de solicitação de pull funcione melhor para todos

Torne sua PR mais simples e focada para que ela possa ser revisada e mesclada mais rapidamente.

Evite solicitações de pull que atualizem um grande número de arquivos ou contenham alterações não relacionadas

Evite criar PRs que contenham alterações não relacionadas. Separe pequenas atualizações para artigos existentes de novos artigos ou regravações principais. Trabalhe nessas alterações em branches de trabalho separados.

As alterações em massa criam PRs com um grande número de arquivos alterados. Limite suas PRs a um máximo de 50 arquivos alterados. PRs grandes são difíceis de revisar e são mais propensos a conter erros.

Renomeando ou excluindo arquivos

Deve haver um problema associado à PR ao renomear ou excluir arquivos. Esse problema deve discutir a necessidade de renomear ou excluir os arquivos.

Evite misturar adições de conteúdo ou alterações com renomeações e exclusões de arquivo. Qualquer arquivo que você renomear ou excluir deve ser adicionado ao arquivo de redirecionamento apropriado. Quando possível, atualize todos os arquivos que vinculam ao conteúdo renomeado ou excluído, incluindo todos os arquivos TOC.

Evite editar arquivos de configuração do repositório

Evite modificar arquivos de configuração do repositório. Limite suas alterações sempre que possível para os arquivos de conteúdo markdown e todos os arquivos de imagem de suporte necessários para o conteúdo.

Modificações incorretas nos arquivos de configuração do repositório podem interromper o build, introduzir vulnerabilidades ou problemas de acessibilidade ou violar padrões organizacionais. Os arquivos de configuração do repositório são arquivos que correspondem a um ou mais desses padrões:

• *.yml
• .github/**
• .localization-config
• .openpublishing*
• LICENSE*
• reference/docfx.json
• reference/mapping/**
• tests/**
• ThirdPartyNotices
• tools/**

Para segurança e proteção, não altere esses arquivos. Se você achar que um desses arquivos deve ser alterado, registre um problema. Depois que os mantenedores fizerem a triagem do problema, eles farão as alterações apropriadas.

Usar o modelo de PR

Quando você cria uma PR, um modelo é inserido automaticamente no corpo da PR para você. Tem esta aparência:

# PR Summary

<!--
    Delete this comment block and summarize your changes and list
    related issues here. For example:

    This changes fixes problem X in the documentation for Y.

    - Fixes #1234
    - Resolves #1235
-->

## PR Checklist

<!--
    These items are mandatory. For your PR to be reviewed and merged,
    ensure you have followed these steps. As you complete the steps,
    check each box by replacing the space between the brackets with an
    x or by clicking on the box in the UI after your PR is submitted.
-->

- [ ] **Descriptive Title:** This PR's title is a synopsis of the changes it proposes.
- [ ] **Summary:** This PR's summary describes the scope and intent of the change.
- [ ] **Contributor's Guide:** I have read the [contributors guide][contrib].
- [ ] **Style:** This PR adheres to the [style guide][style].

<!--
    If your PR is a work in progress, please mark it as a draft or
    prefix it with "(WIP)" or "WIP:"

    This helps us understand whether or not your PR is ready to review.
-->

[contrib]: /powershell/scripting/community/contributing/overview
[style]: /powershell/scripting/community/contributing/powershell-style-guide

Na seção "Resumo de PR", escreva um breve resumo de suas alterações e liste quaisquer problemas relacionados pelo número de problema, como #1234. Se o PR corrigir ou resolver o problema, use o recurso de fechamento automático do GitHub para que o problema seja fechado automaticamente quando seu PR for mesclado.

Examine os itens na seção "Lista de Verificação de PR" e marque-os à medida que você concluir cada um deles. Você deve seguir as instruções e verificar cada item para que a equipe aprove sua PR.

Se a PR for um trabalho em andamento, defina-a como modo de rascunho ou prefixe seu título de PR com WIP.

Comentário de expectativas

Depois de enviar sua PR, um bot comentará sobre sua PR. O comentário fornece recursos e define expectativas para o restante do processo. Podemos atualizar esse comentário periodicamente, portanto, sempre examine o comentário, mesmo que esta não seja sua primeira contribuição.

Serviço de validação de PR do Docs

O serviço de validação de PR do Docs é um aplicativo GitHub que executa regras de validação em suas alterações. Você deve corrigir erros ou avisos relatados pelo serviço de validação.

As etapas a seguir descrevem o comportamento de validação:

1. Você envia uma PR.

2. No comentário do GitHub que indica o status das "verificações" habilitadas no repositório. Neste exemplo, há duas verificações habilitadas: "Commit Validation" e "OpenPublishing.Build".

   

   O build pode ser aprovado mesmo se a validação de commit falhar.

3. Selecione Detalhes para obter mais informações. A página Detalhes mostra todas as verificações de validação que falharam e inclui informações sobre como corrigir os problemas.

4. Quando a validação for bem-sucedida, o seguinte comentário será adicionado à PR:

   

Observação

Se você for um colaborador externo (não um funcionário da Microsoft), não terá acesso aos relatórios de build detalhados ou aos links de visualização.

Quando a PR é revisada, você pode ser solicitado a fazer alterações ou corrigir mensagens de aviso de validação. A equipe de PowerShell-Docs pode ajudá-lo a entender os erros de validação e os requisitos editoriais.

Ações do GitHub

Várias ações diferentes do GitHub são executadas em relação às suas alterações para validar e fornecer contexto para você e os revisores.

Verificação de lista

Se a sua Pull Request não estiver no modo de rascunho e não estiver prefixada com WIP, uma ação do GitHub inspeciona a sua Pull Request para verificar se você selecionou cada item na lista de verificação do modelo de Pull Request. Os mantenedores não revisarão nem mesclarão sua PR até que você conclua a lista de verificação. Os itens da lista de verificação são obrigatórios.

Verificação de autorização

Se o PR for direcionado ao live branch ou modificar os arquivos de configuração do repositório, uma Ação do GitHub verificará suas permissões para verificar se você está autorizado a enviar essas alterações.

Somente os administradores do repositório estão autorizados a direcionar o live branch ou modificar os arquivos de configuração do repositório.

Relatório de alterações de conteúdo versionadas

Se o PR adicionar, remover ou modificar qualquer conteúdo com versão, o GitHub Action analisará suas alterações e gravará um relatório resumindo os tipos de alterações feitas no conteúdo com versão.

Este relatório pode mostrar se há outras versões dos arquivos que você precisa atualizar nesta PR.

Para localizar o relatório de conteúdo com versão para sua PR:

1. Selecionando a guia "Verificações" na página de PR.
2. Selecione o trabalho "de Relatórios" da lista de trabalhos.
3. Selecione "..." botão no canto superior direito.
4. Selecione "Exibir resumo do trabalho".

Próximas etapas

guia de estiloPowerShell-Docs

Recursos adicionais

Como gerenciamos solicitações de pull