docs: adicionar template de pull request - #466
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository YAML (base), Central YAML (inherited) Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds a Portuguese GitHub pull request template with prompts for context, changes, validation, evidence, and related issues. Adds workflow guidance that requires agents to use and preserve the template, document validation commands, reference related issues, avoid fabricated evidence, and describe behavioral impact. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/pull_request_template.md:
- Around line 18-20: Update the pull request template placeholder rows in all
referenced sections, including the incomplete “Closes #” entry, so they are
hidden inside HTML comments or replaced with clear prompts that cannot be
submitted as real PR content.
🪄 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: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: 2f7b38ba-0f7b-497e-96d1-d84c19698258
📒 Files selected for processing (1)
.github/pull_request_template.md
fernanduandrade
added
github_actions
|
Entendo seu ponto e faz sentido e até torna a leitura mais prática com o tempo. Mas acho que cabe uma discussão do que acontece se um PR não seguir esse template, terá que ser refeito? Ou não será aceito devido a descrição do PR mesmo solucionando o problema? Por não ter um padrão voce sentiu dificuldade em entender algum PR? Não sei seria possivel dentro do ci/cd validar isso, mas cabe averiguar. |
Já me foi solcitado incluir algumas descrições na PR e que fazia sentido incluir para deixar o contexto dela um pouco melhor. Por não ter um padrão acreditava que estava ok a descrição da PR, mas tinha como melhorar. A ideia é que não seja um fator obrigatório a seguir e também não invalidar as PR que não estejam no padrão do template, mais apenas orientar, servir de guia e já ter um texto pronto com alguns campos para facilitar a abertura a PR. |
Então a maioria das perguntas foram respondidas, somente sobre PR que não seguir o template será considerado "errado"? Poderia marcar quem te solicitou se achar conveniente pra responder isso |
|
Faz falta mesmo, procurei aqui e não tem template nenhum no repo hoje. A estrutura tá boa, principalmente separar plano de testes de evidências. Duas sugestões. O plano de testes podia já vir com A outra é mistura de idioma. Tem "Summary" convivendo com "Alterações", "Plano de Testes", "Evidências" e "Issues Relacionadas". Escolhe um dos dois. Como o template existe justamente pra receber gente nova da comunidade, eu iria de português inteiro e viraria "Resumo". Nit bobo: o |
Bem pontuado realmente fica bem mais coerente Inclui no modelo esses checks e mantive o padrão pt-BR. |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.ai/guidelines/workflow/05-pull-requests.blade.php:
- Around line 7-15: Revise the guidance around pull request creation and the
“Required behavior” section so using `.github/pull_request_template.md` is
recommended rather than mandatory. Replace blocking language such as “MUST” and
required-section enforcement with advisory wording, and explicitly state that a
missing or nonconforming template does not block the pull request.
🪄 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: Repository YAML (base), Central YAML (inherited)
Review profile: CHILL
Plan: Pro Plus
Run ID: eb4483af-3a9d-43e9-8124-47feea88155a
📒 Files selected for processing (2)
.ai/guidelines/workflow/05-pull-requests.blade.php.github/pull_request_template.md
5 participants
Summary
Atualmente, o repositório não possui um padrão definido para a descrição de Pull Requests. Como consequência, cada PR é estruturado de forma diferente, dificultando a revisão, a reprodução dos testes e a identificação das alterações realizadas.
Este PR adiciona um template de Pull Request para padronizar a abertura de novas contribuições, orientando os colaboradores a documentarem:
Além de tornar o processo de revisão mais consistente, este template também serve como um guia para novos contribuidores. Como a comunidade incentiva a participação de pessoas com diferentes níveis de experiência, o template fornece uma orientação clara sobre quais informações devem ser incluídas em um Pull Request, tornando o processo de contribuição mais simples, organizado e acolhedor.
Alterações