Skip to content

Latest commit

 

History

History
177 lines (104 loc) · 9.95 KB

PULL_REQUEST_TEMPLATE.md

File metadata and controls

177 lines (104 loc) · 9.95 KB

👋 Bem-vindo. Siga as etapas abaixo para nos contar sobre sua contribuição.

1. Use o modelo correto para sua contribuição:

🐛 1.1. Você está corrigindo um bug

1.1.1. Requisitos para contribuir com uma correção de bug
  • Preencha o modelo abaixo. Qualquer pull request que não inclua informações suficientes para serem revisadas em tempo hábil pode ser encerrada a critério dos mantenedores.
  • A solicitação pull deve corrigir apenas um bug existente. Para contribuir com outras alterações, você deve usar um modelo diferente.
  • A solicitação pull deve atualizar o conjunto de testes para demonstrar a funcionalidade alterada.
  • Depois de criar o pull request, todas as verificações de status devem ser aprovadas antes que um mantenedor analise sua contribuição.
1.1.2. Identifique o Bug

Link para o problema que descreve o bug que você está corrigindo.

Se ainda não houver um problema para seu bug, abra um novo problema e vincule-o a esse problema em sua solicitação pull. Nota: Em alguns casos, o "bug" de uma pessoa é o "recurso" de outra pessoa. Se o pull request não resolver um problema existente com o rótulo "bug", os mantenedores têm a palavra final sobre se o comportamento atual é um bug.

1.1.3. Descrição da alteração

Devemos ser capazes de entender o design de sua alteração a partir desta descrição. Se não conseguirmos ter uma boa ideia do que o código fará a partir da descrição aqui, o pull request pode ser fechado a critério dos mantenedores. Tenha em mente que o mantenedor que está revisando este PR pode não estar familiarizado ou ter trabalhado com o código aqui recentemente, então por favor nos guie pelos conceitos.

1.1.4. Designs alternativos

Explique quais outras alternativas foram consideradas e por que a versão proposta foi selecionada.

1.1.5. Possíveis desvantagens

Quais são os possíveis efeitos colaterais ou impactos negativos da alteração do código?

1.1.6. Processo de verificação

Que processo você seguiu para verificar se a mudança não introduziu regressões? Descreva as ações executadas (incluindo botões em que clicou, texto digitado, comandos executados etc.) e descreva os resultados observados.

1.1.7. Notas de lançamento

Descreva as alterações em uma única linha que explique essa melhoria no termos que um usuário pode entender. Este texto será usado nas notas de lançamento de futuras versões.

Se essa alteração não for voltada para o usuário ou notável o suficiente para ser incluída nas notas de versão você pode usar as strings "Não aplicável" ou "N/A" aqui.

1.1.8. Exemplos:
  • O pacote GitHub agora permite adicionar coautores aos commits.
  • Corrigido um problema em que vários cursores não funcionavam em um arquivo com uma única linha.
  • Aumento do desempenho de busca e substituição em todo o projeto.

📈 1.2. Você está melhorando o desempenho

1.2.1. Requisitos para contribuir com uma melhoria de desempenho
  • Preencha o modelo abaixo. Qualquer pull request que não inclua informações suficientes para serem revisadas em tempo hábil pode ser encerrada a critério dos mantenedores.
  • A solicitação pull deve afetar apenas o desempenho da funcionalidade existente. Para contribuir com outras alterações, você deve usar um modelo diferente.
  • Depois de criar o pull request, todas as verificações de status devem ser aprovadas antes que um mantenedor analise sua contribuição.
1.2.2. Descrição da alteração

Devemos ser capazes de entender o design de sua alteração a partir desta descrição. Se não conseguirmos ter uma boa ideia do que o código fará a partir da descrição aqui, o pull request pode ser fechado a critério dos mantenedores. Tenha em mente que o mantenedor que está revisando este PR pode não estar familiarizado ou ter trabalhado com o código aqui recentemente, então por favor nos guie pelos conceitos.

1.2.3. Benefícios de desempenho quantitativos

Descreva a melhoria de desempenho exata observada (por exemplo, tempo reduzido para concluir uma operação, uso reduzido de memória etc.). Descreva como você mediu essa mudança. Pontos de bônus por incluir gráficos que demonstram a melhoria ou dumps anexados das ferramentas de criação de perfil integradas.

1.2.4. Possíveis desvantagens

Quais são os possíveis efeitos colaterais ou impactos negativos da alteração do código?

1.2.5. Processo de verificação

Que processo você seguiu para verificar se a mudança não introduziu regressões? Descreva as ações executadas (incluindo botões em que clicou, texto digitado, comandos executados etc.) e descreva os resultados observados.

1.2.6. Problemas aplicáveis

Insira quaisquer problemas aplicáveis aqui.

1.2.7. Notas de lançamento

Descreva as alterações em uma única linha que explique essa melhoria no termos que um usuário pode entender. Este texto será usado nas notas de lançamento de futuras versões.

Se essa alteração não for voltada para o usuário ou notável o suficiente para ser incluída nas notas de versão você pode usar as strings "Não aplicável" ou "N/A" aqui.

1.2.8. Exemplos:
  • O pacote GitHub agora permite adicionar coautores aos commits.
  • Corrigido um problema em que vários cursores não funcionavam em um arquivo com uma única linha.
  • Aumento do desempenho de busca e substituição em todo o projeto.

📝 1.3. Você está atualizando a documentação

1.3.1. Requisitos para Contribuição de Documentação
  • Preencha o modelo abaixo. Qualquer pull request que não inclua informações suficientes para serem revisadas em tempo hábil pode ser encerrada a critério dos mantenedores.
  • A solicitação pull deve contribuir apenas com documentação (por exemplo, arquivos de remarcação ou documentos de API). Para contribuir com outras alterações, você deve usar um modelo diferente.
1.3.2. Descrição da alteração

Devemos ser capazes de entender o propósito de sua alteração a partir desta descrição. Se não conseguirmos ter uma boa ideia dos benefícios da mudança na descrição aqui, a solicitação pull pode ser fechada a critério dos mantenedores.

1.3.3. Notas de lançamento

Descreva as alterações em uma única linha que explique essa melhoria no termos que um usuário pode entender. Este texto será usado nas notas de lançamento de futuras versões.

Se essa alteração não for voltada para o usuário ou notável o suficiente para ser incluída nas notas de versão você pode usar as strings "Não aplicável" ou "N/A" aqui.

1.3.4. Exemplos:
  • O pacote GitHub agora permite adicionar coautores aos commits.
  • Corrigido um problema em que vários cursores não funcionavam em um arquivo com uma única linha.
  • Aumento do desempenho de busca e substituição em todo o projeto.

💻 1.4. Você está alterando a funcionalidade

1.4.1. Requisitos para adicionar, alterar ou remover um recurso
  • Preencha o modelo abaixo. Qualquer pull request que não inclua informações suficientes para serem revisadas em tempo hábil pode ser encerrada a critério dos mantenedores.
  • O pull request deve contribuir com uma mudança que tenha sido endossada pela equipe do mantenedor. Veja detalhes no modelo abaixo.
  • A solicitação pull deve atualizar o conjunto de testes para exercer a funcionalidade atualizada.
  • Depois de criar o pull request, todas as verificações de status devem ser aprovadas antes que um mantenedor analise sua contribuição.
1.4.2. Emissão ou RFC endossada pelos mantenedores

O problema ou RFC ao qual sua alteração está relacionada deve ser um dos seguintes:

  • Um problema em aberto com o rótulo preciso de ajuda
  • Um problema em aberto com o rótulo triaged
  • Um RFC com status "aceito"

Para contribuir com um aprimoramento que não é coberto por um dos itens acima, siga nosso guia para sugerir um aprimoramento.

Para contribuir com outras alterações, você deve usar um modelo diferente.

1.4.3. Descrição da alteração

Devemos ser capazes de entender o design de sua alteração a partir desta descrição. Se não conseguirmos ter uma boa ideia do que o código fará a partir da descrição aqui, o pull request pode ser fechado a critério dos mantenedores. Tenha em mente que o mantenedor que está revisando este PR pode não estar familiarizado ou ter trabalhado com o código aqui recentemente, então por favor nos guie pelos conceitos.

1.4.4. Designs alternativos

Explique quais outras alternativas foram consideradas e por que a versão proposta foi selecionada.

1.4.5. Possíveis desvantagens

Quais são os possíveis efeitos colaterais ou impactos negativos da alteração do código?

1.4.6. Processo de verificação

Que processo você seguiu para verificar se sua mudança tem os efeitos desejados?

  • Como você verificou se todas as novas funcionalidades funcionam conforme o esperado?
  • Como você verificou se todas as funcionalidades alteradas funcionam conforme o esperado?
  • Como você verificou que a mudança não introduziu regressões?

Descreva as ações executadas (incluindo botões em que clicou, texto digitado, comandos executados etc.) e descreva os resultados observados.

1.4.7. Notas de lançamento

Descreva as alterações em uma única linha que explique essa melhoria no termos que um usuário pode entender. Este texto será usado nas notas de lançamento de futuras versões.

Se essa alteração não for voltada para o usuário ou notável o suficiente para ser incluída nas notas de versão você pode usar as strings "Não aplicável" ou "N/A" aqui.

1.4.8. Exemplos:
  • O pacote GitHub agora permite adicionar coautores aos commits.
  • Corrigido um problema em que vários cursores não funcionavam em um arquivo com uma única linha.
  • Aumento do desempenho de busca e substituição em todo o projeto.

2. Substitua este texto pelo conteúdo do modelo

3. Preencha todas as seções do modelo

4. Clique em "Criar solicitação pull"