Pull Requests e Revisões

Como Participar em Discussões

Abra uma Discussão para fazer perguntas, dar feedback e propor novas ideias. Se sua proposta se qualificar, nós a converteremos em uma "Issue" (a discussão pode levar algum tempo).

Por exemplo, você pode iniciar uma discussão como "Adicionar uma vulnerabilidade sobre rotação de chaves" para o MASWE ou "Adicionar um caso de teste para rotação de chaves no Android" para o MASTG.

Assim que obtiver sua resposta, por favor marque-a como respondida. Quando você marca uma pergunta como resposta, o GitHub destacará o comentário e as respostas a ele para ajudar visitantes a encontrarem rapidamente a resposta.

Nota: O texto na imagem permanece em inglês.

Como Criar Issues

Crie uma issue antes de abrir um pull request. Descreva claramente o problema ou funcionalidade que você planeja trabalhar.

Antes de criar uma issue:

• Verifique se ela já existe. Se encontrar uma issue relacionada, comente nela em vez de criar uma nova.
• Divida problemas complexos em tarefas menores (issues) quando possível.

Ao criar uma issue, siga estas diretrizes:

• Use um título claro e descritivo.
• Inclua contexto detalhado, etapas para reproduzir (se reportando um bug) e comportamento esperado.

Em seguida, se você gostaria de trabalhar na issue, solicite ser atribuído a ela. Você pode fazer isso clicando na seção "Assignees" na barra lateral direita da página da issue e selecionando a si mesmo ou pedindo para ser atribuído por um maintainer.

Como Abrir um PR

Abra um PR para contribuir com conteúdo ou correções.

• O branch de destino deve ser master ou main.
• Se seu PR fecha uma issue, escreva "Closes #<issue-id>" no início da descrição do PR.
• Siga nosso guia de estilo ao escrever conteúdo.
• Faça auto-revisão das suas alterações localmente e no GitHub.

Em seguida, você pode solicitar uma revisão conforme descrito na próxima seção.

Como Obter Revisão do seu PR

Solicite uma revisão de um de nossos maintainers ou contribuidores. Você pode fazer isso clicando na seção "Reviewers" na barra lateral direita da página do PR e selecionando o(s) usuário(s) que você deseja que revisem seu PR.

Se você não tiver as permissões corretas para solicitar uma revisão, por favor escreva um comentário no PR mencionando-nos (@cpholguera, @sushi2k ou @TheDauntless) e nós atribuiremos um revisor para você.

Uma vez solicitada uma revisão, ela será revisada por um de nossos maintainers ou contribuidores. Eles verificarão suas alterações e fornecerão feedback.

Como Incorporar o Feedback do Revisor ao seu PR

Incorpore o feedback dos revisores em seu PR seguindo estes passos:

• Aplique quaisquer Alterações Sugeridas usando o botão "Commit suggestions".
• Para processar um comentário, simplesmente faça modificações diretamente no seu branch e faça push normalmente. O GitHub detectará automaticamente essas alterações e as adicionará ao seu PR existente.
• Conforme você atualiza seu PR e aplica alterações, marque cada conversa como resolvida.
• Se você encontrar problemas de merge, consulte esta página para aprender como resolvê-los.

NOTA: Lembre-se de sincronizar regularmente seu fork com o repositório upstream: git pull upstream/master

Como Revisar um PR

Revise PRs e também ganhe contribuições.

• Solicite ser atribuído a PRs que correspondam à sua expertise.
• Certifique-se de seguir nosso guia de estilo ao revisar conteúdo.

Se você gostaria de revisar um PR aberto, siga estes passos:

Passo 1: Comente e Sugira Alterações

Comente em um PR usando comentários de linha única ou múltiplas linhas (clique e arraste para selecionar o intervalo de linhas):

Nota: O texto na imagem permanece em inglês.

Prefira sempre fazer "Alterações Sugeridas" usando o botão ±:

Nota: O texto na imagem permanece em inglês.

Se a sugestão que você gostaria de fazer não puder ser expressa usando "alterações sugeridas", por favor insira um comentário claro explicando o que deve ser corrigido (ex: alguns parágrafos não estão vinculados corretamente ou algumas informações essenciais não podem ser encontradas e devem ser adicionadas).

Usar "Alterações Sugeridas" economiza muito tempo para você como revisor e para o autor do PR. E você ganha pontos (atribuições) pelas alterações que sugeriu (se o autor fizer commit delas, você se torna co-autor desses commits). Se você for constante com seu trabalho de revisor, pode se candidatar a ser reconhecido como revisor oficial em nossa página de Agradecimentos.

Passo 2: Envie sua Revisão

Envie sua revisão depois de revisar o PR inteiro.

1. Clique em "Review changes".
2. Insira um comentário para o contribuidor.
3. Selecione o tipo de revisão que você gostaria de deixar (Comment, Approve ou Request Changes).
4. Clique em "Submit review".