[chore]: Update PR template with guidance and fixes#1445
[chore]: Update PR template with guidance and fixes#1445
Conversation
| - [ ] **[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 |
There was a problem hiding this comment.
Removendo os checkbox - [ ] para não induzir as pessoas a pensar que é um formulário
|
|
||
|
|
||
| ## 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**: |
There was a problem hiding this comment.
Na verdade não temos mais o canal "Correções de PRs, arquiteturas e afins". Vou alterar
Bem interessante o material do cbeam Pedro! De fato, precisamos melhorar a descrição dos commits p/ história passar a fazer sentido e ser efetivamente utilizada p/ acompanhar a evolução do repo ao longo do tempo |
aspeddro
force-pushed
the
pr-template-update
branch
from
e9268e9 to
949435c
Compare
|
Apenas para esclarecer. Acho os títulos dos commit no geral bom. O corpo do commit pode não ser necessário porque o título é auto descritivo ou as modificações são simples. Não é uma regra rígida, só acho que o corpo da mensagem não deveria ser o template do PR com os campos marcado. |
Acredito que a utilização do Conventional Commits será legal nesse momento de discussão das padronizações do commits. De certa medida, já usamos, mas acredito que adotarmos como documentação oficial do repositório seja o ideal: https://www.conventionalcommits.org/en/v1.0.0/ Em relação ao corpo do e-mail e o checkbox, quando coloquei, foi por achar mais intuitivo, mas acredito que haja realmente essa duplicidade de estarem utilizando o template no corpo de mensagem. Enfim, concordo em remover os checkbox. |
|
Sou a favor do conventional commits. Não sugiro remover. O objetivo desse PR é esclarecer que o template do PR não seja a mensagem do commit e até mesmo o corpo do PR. Modifiquei uma configuração para que o corpo da mensagem seja o commit e não a mensagem do PR. |
Perfeito. Então, acredito que seja necessário colocar na documentação que o nosso padrão de commits é pelo |
Adiciono em CONTRIBUTING.md? |
Sim, acredito que adicionar em CONTRIBUTING.md seja o ideal. |
|
Acho que podemos levar esse PR para prod, @aspeddro. |
|
Ainda não. Tenho que atualizar o CONTRIBUTING.md |
📝 WalkthroughWalkthroughThe GitHub pull request template was updated with improved formatting, clarified commit message guidance, enhanced PR naming conventions using bracketed keywords, added a Portuguese "Porque mudou?" field, fixed a typo in the "Dependências" heading, and updated the Discord channel reference for reviewer navigation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
.github/pull_request_template.md (2)
71-73: Align GitHub UI wording and reviewer term.Para evitar ambiguidade com a interface do GitHub, prefira “Ready for review” (singular). Também vale padronizar “revisores” em vez de “revisadores”.
✏️ Suggested wording fix
-- 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) no canal **Plataforma > Dados** e marque a **@equipe_dados**: - - Revisadores recomendados no github: +- Quando o PR estiver pronto para ser revisado, retire o **Draft** através do **Ready for review**, marque os revisores do repositório, envie o PR no nosso [discord](https://discord.gg/V3yTWRYWZZ) no canal **Plataforma > Dados** e marque a **@equipe_dados**: + - Revisores recomendados no GitHub:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/pull_request_template.md around lines 71 - 73, Update the PR template text to use GitHub's exact UI wording and consistent reviewer terminology: replace the phrase "Ready for reviews" with "Ready for review" and change "revisadores" to "revisores" so the sentence that currently mentions "retire o **Draft** através do **Ready for reviews**, marque os revisadores..." becomes aligned and unambiguous; ensure the modified sentence still references marking repository reviewers and notifying the Discord channel as before.
53-53: Consider replacing “Cloud” with PT-BR term for consistency.Se o restante do template está em português, “na nuvem” mantém consistência de linguagem.
✏️ Suggested wording fix
- - Testado na Cloud + - Testado na nuvem🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/pull_request_template.md at line 53, The template contains the English loanword "Testado na Cloud" which breaks PT-BR consistency; replace the string "Testado na Cloud" with the PT-BR equivalent (for example "Testado na nuvem") so the pull request template uses Portuguese consistently across the file.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.github/pull_request_template.md:
- Line 10: Replace the incorrect contiguous-word interrogative "Porque mudou?"
with the correct split interrogative "Por que mudou?" wherever it appears in the
PR template; search for the exact string "Porque mudou?" (noting occurrences
mentioned at the two locations) and update them to "Por que mudou?" to fix the
phrasing.
- Line 33: Replace the incorrect clitic accentuation "coloca-lo" with the
correct "colocá-lo" in the PR template string; locate the line containing the
phrase "Ao abrir o PR, deverá coloca-lo como draft" and update it to "Ao abrir o
PR, deverá colocá-lo como draft" so the template uses proper PT-BR orthography.
---
Nitpick comments:
In @.github/pull_request_template.md:
- Around line 71-73: Update the PR template text to use GitHub's exact UI
wording and consistent reviewer terminology: replace the phrase "Ready for
reviews" with "Ready for review" and change "revisadores" to "revisores" so the
sentence that currently mentions "retire o **Draft** através do **Ready for
reviews**, marque os revisadores..." becomes aligned and unambiguous; ensure the
modified sentence still references marking repository reviewers and notifying
the Discord channel as before.
- Line 53: The template contains the English loanword "Testado na Cloud" which
breaks PT-BR consistency; replace the string "Testado na Cloud" with the PT-BR
equivalent (for example "Testado na nuvem") so the pull request template uses
Portuguese consistently across the file.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 148e5b7b-69ed-4df4-98ff-416aa69f5f83
📒 Files selected for processing (1)
.github/pull_request_template.md
| - Nomeação do pull request | ||
| - Descrição e explicação de maneira clara e concisa o objetivo desse PR | ||
| - O que mudou? | ||
| - Porque mudou? |
There was a problem hiding this comment.
Use “Por que” in interrogative prompts.
Nesses dois pontos a frase é pergunta direta; o correto é “Por que mudou?”.
✏️ Suggested wording fix
- - Porque mudou?
+ - Por que mudou?-- Explique de maneira clara e concisa o objetivo deste PR. Qual o problema que ele resolve? Porque mudou?
+- Explique de maneira clara e concisa o objetivo deste PR. Qual o problema que ele resolve? Por que mudou?Also applies to: 37-37
🧰 Tools
🪛 LanguageTool
[uncategorized] ~10-~10: Se “Porque” expressar um questionamento, considere escrever “por que”. Se for uma afirmação, pondere alterar para “é porque”.
Context: ... objetivo desse PR - O que mudou? - Porque mudou? ## Nomeação do Pull Request A ...
(POR_QUE_PORQUE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md at line 10, Replace the incorrect
contiguous-word interrogative "Porque mudou?" with the correct split
interrogative "Por que mudou?" wherever it appears in the PR template; search
for the exact string "Porque mudou?" (noting occurrences mentioned at the two
locations) and update them to "Por que mudou?" to fix the phrasing.
|
|
||
| ## Draft: | ||
|
|
||
| - Ao abrir o PR, deverá coloca-lo como draft |
There was a problem hiding this comment.
Fix clitic accentuation in PT-BR.
“coloca-lo” deve ser “colocá-lo”.
✏️ Suggested wording fix
-- Ao abrir o PR, deverá coloca-lo como draft
+- Ao abrir o PR, deverá colocá-lo como draft📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Ao abrir o PR, deverá coloca-lo como draft | |
| - Ao abrir o PR, deverá colocá-lo como draft |
🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: Possível erro de acentuação.
Context: ...n** ## Draft: - Ao abrir o PR, deverá coloca-lo como draft ## Descrição do PR: - Expl...
(ACENTUAÇÃO_VOGAL_ÊNCLISE)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In @.github/pull_request_template.md at line 33, Replace the incorrect clitic
accentuation "coloca-lo" with the correct "colocá-lo" in the PR template string;
locate the line containing the phrase "Ao abrir o PR, deverá coloca-lo como
draft" and update it to "Ao abrir o PR, deverá colocá-lo como draft" so the
template uses proper PT-BR orthography.
3 participants
Atualiza o template de pull requests.
Observei que as pessoas estão usando o template na mensagem de commit quando na verdade ele deve ser um guia para preencher seu PR.
Exemplo de commit:
O corpo da mensagem poderia ser:
Podem olhar em https://github.com/basedosdados/pipelines/commits/main/
As mensagem de commits devem explicar o motivo da alteração.
Para referência: https://chris.beams.io/git-commit
Summary by CodeRabbit