From fe6af190ac844035a1346a81a4b70ecd1fd8dd67 Mon Sep 17 00:00:00 2001 From: tricktx Date: Fri, 20 Sep 2024 17:48:11 -0300 Subject: [PATCH 1/3] first version the template pull requests --- .github/pull_requests_template.md | 73 +++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 .github/pull_requests_template.md diff --git a/.github/pull_requests_template.md b/.github/pull_requests_template.md new file mode 100644 index 000000000..349b55d1e --- /dev/null +++ b/.github/pull_requests_template.md @@ -0,0 +1,73 @@ + +# Template Pull Requests - Pipeline + +## Nomeação do Pull Request + +A nomeação de cada Pull Request (PR) deve seguir o seguinte padrão: + +- O título de cada Pull Request (PR) deve começar com uma das seguintes palavras-chave, entre colchetes. Além disso, **marque a palavra-chave que melhor descreve o seu PR atual**: + - [ ] **[Feature]**: Para novas funcionalidades. + - [ ] **[Data]**: Para subida de novos dados em produção. + - [ ] **[Bugfix]**: Para correções de bugs. + - [ ] **[Refactor]**: Para mudanças no código que não alteram a funcionalidade. + - [ ] **[Docs]**: Para atualizações na documentação. + - [ ] **[Test]**: Para mudanças relacionadas a testes. + - [ ] **[Chore]**: Para tarefas menores e de manutenção. + - [ ] **[Deactivate]**: Para desativar o schedule da Pipeline +--- + - Exemplos de título: + - **[docs] br_me_caged** + - **[Feature] br_cgu_servidores_publicos** + +## Draft: +- Ao abrir o PR, deverá coloca-lo como draft + +## Descrição do PR: + +- Explique de maneira clara e concisa o objetivo deste PR. O que foi alterado? Qual o problema que ele resolve? + - **Motivação/Contexto:** + + +## Detalhes Técnicos: + +- Detalhe as mudanças mais técnicas, como ajustes na pipeline, scripts ou modelo de dados utilizado. + + - **Principais alterações na pipeline/scripts:** + - **Mudanças nos dados e no schema:** + - **Impacto no desempenho:** + +## Teste e Validações: + +- Relate os testes e validações relacionado aos dados/script: + - [ ] Testado localmente + - [ ] Testado na Cloud + + **Caso haja algo relacionado aos testes que vale a pena informar:** + +## Riscos e Mitigações: +- Identifique os riscos potenciais desta mudança e como mitigar esses Riscos + + - Riscos conhecidos: + - Planos de rollback: + +## Dependencias: +- Liste quaisquer dependências externas, como bibliotecas, outros PRs ou mudanças que precisam ser feitas antes deste merge. + - [ ] Dependências: + - [ ] Nenhuma dependencias adicional + +## Revisão do código: +- Relate se há algum ponto no código (função, async, download e etc) que precisa de maior atenção: + + - **Ponto de atenção:** + - Exemplo: task.py, download_file_async, linha: 48 + + +## Revisadores: +- Quando o PR estiver pronto para ser revisado, retire o **Draft** através do **Ready for reviews**, marque os revisadores de repositório, envie o PR no nosso [discord](https://discord.gg/V3yTWRYWZZ) na aba **Correções de PRs, arquiteturas e afins** e marque a **@equipe_dados**: + - Revisadores recomendados: + - @tricktx + - @folhesgabriel + - @laura-l-amaral + - @aspeddro + - @Winzen + - @vilelaluiza From 80883190f1d831bafe2e1ecb426aa5a5303d3c83 Mon Sep 17 00:00:00 2001 From: tricktx Date: Fri, 20 Sep 2024 17:51:52 -0300 Subject: [PATCH 2/3] fix name file --- .github/{pull_requests_template.md => pull_request_template.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{pull_requests_template.md => pull_request_template.md} (100%) diff --git a/.github/pull_requests_template.md b/.github/pull_request_template.md similarity index 100% rename from .github/pull_requests_template.md rename to .github/pull_request_template.md From 8b61586f35caf31901351e1b0f56fe9b2ed7bc56 Mon Sep 17 00:00:00 2001 From: tricktx Date: Tue, 22 Oct 2024 16:27:01 -0300 Subject: [PATCH 3/3] to alter reviews to basedosdados/dados and move file attention to technical --- .github/pull_request_template.md | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 349b55d1e..481eec623 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -36,6 +36,8 @@ A nomeação de cada Pull Request (PR) deve seguir o seguinte padrão: - **Mudanças nos dados e no schema:** - **Impacto no desempenho:** +- Se alguma parte do código precisar de alguma atenção a mais, comente na linha sinalizando para os revisores. + ## Teste e Validações: - Relate os testes e validações relacionado aos dados/script: @@ -55,19 +57,8 @@ A nomeação de cada Pull Request (PR) deve seguir o seguinte padrão: - [ ] Dependências: - [ ] Nenhuma dependencias adicional -## Revisão do código: -- Relate se há algum ponto no código (função, async, download e etc) que precisa de maior atenção: - - - **Ponto de atenção:** - - Exemplo: task.py, download_file_async, linha: 48 - ## Revisadores: - Quando o PR estiver pronto para ser revisado, retire o **Draft** através do **Ready for reviews**, marque os revisadores de repositório, envie o PR no nosso [discord](https://discord.gg/V3yTWRYWZZ) na aba **Correções de PRs, arquiteturas e afins** e marque a **@equipe_dados**: - - Revisadores recomendados: - - @tricktx - - @folhesgabriel - - @laura-l-amaral - - @aspeddro - - @Winzen - - @vilelaluiza + - Revisadores recomendados no github: + - basedosdados/dados