robertolima-dev / pull-request

Este repositório contém instruções passo a passo para usar pull requests, incluindo como criar e usar templates de pull request. Aprenda a criar pull requests efetivos, bem documentados e de fácil revisão usando templates de pull request.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool


Pull Request

Um pull request é um pedido de contribuição enviado por um desenvolvedor para um projeto de software. O pull request contém o código que o desenvolvedor deseja adicionar ao projeto. O proprietário do projeto pode então revisar o código e aceitar ou rejeitar a solicitação. Se aceito, o código é adicionado ao projeto. código e aceitar ou rejeitar a solicitação. Se aceito, o código é adicionado ao projeto.

Benefícios

  1. Maior colaboração: Os pull requests permitem que os desenvolvedores colaborem facilmente em projetos de software. Isso significa que os desenvolvedores podem contribuir com seu código sem ter que se preocupar com a integração de suas alterações no projeto.

  2. Maior qualidade: Os pull requests permitem que os proprietários do projeto revejam o código antes de aceitá-lo. Isso significa que o código adicionado ao projeto é de melhor qualidade.

  3. Maior segurança: Os pull requests permitem que os proprietários do projeto revejam o código antes de aceitá-lo. Isso significa que o código adicionado ao projeto é mais seguro.

Boas práticas

  1. Escreva uma boa descrição: Uma boa descrição de pull request deve explicar claramente o que o código faz e por que foi adicionado ao projeto.

  2. Seja específico: Seu pull request deve ser o mais específico possível. Isso significa que você deve incluir todos os detalhes necessários para que outros desenvolvedores possam entender o que está acontecendo.

  3. Teste seu código: Antes de enviar um pull request, certifique-se de que seu código está funcionando corretamente. Isso significa que você deve testar seu código para garantir que ele está fazendo o que você espera.

  4. Seja paciente: Os proprietários do projeto podem demorar um pouco para rever seu pull request. Portanto, é importante ter paciência e esperar que eles revejam o código antes de tomar qualquer ação.

Exemplos de descrição

  1. Adicionar novo recurso de login: Este pull request adiciona um novo recurso de login ao projeto. O código inclui a criação de uma nova página de login, a validação de credenciais e a criação de sessões.

  2. Corrigir bug de upload de arquivos: Este pull request corrige um bug no upload de arquivos. O código inclui a correção de um erro de validação que impedia o upload de arquivos.

  3. Melhorar a performance do banco de dados: Este pull request melhora a performance do banco de dados. O código inclui a otimização de consultas e a criação de índices para melhorar a velocidade de execução.

Template de pull request:

# Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules



Copyright © 2023 - robertolima-dev

LICENÇA

About

Este repositório contém instruções passo a passo para usar pull requests, incluindo como criar e usar templates de pull request. Aprenda a criar pull requests efetivos, bem documentados e de fácil revisão usando templates de pull request.