Automação de mensagens para PRs usando bot com GitHub Actions

[camilamaia]

Descrição

Criar um bot utilizando GitHub Actions que envia mensagens automatizadas nos comentários de PRs com base nos seguintes comandos.

*Os exemplos de nome de comandos e mensagens são apenas sugestões e podem ser modificados conforme necessário.

Comandos

1. !bot-caramelo título-pr-vago

   Quando alguém comentar no PR com esse comando, o bot deve comentar uma mensagem explicando que o título do PR está pouco descritivo. A mensagem deve marcar a pessoa que criou o PR e fornecer exemplos e a importância de usar títulos claros e descritivos.

   Mensagem combinada (pt-br & inglês):

   Olá @, o título deste PR está um pouco vago. É importante ter um título claro que explique de forma breve o objetivo da mudança. Isso ajuda os revisores a entenderem rapidamente do que se trata o PR. Por exemplo:

   TÍTULO VAGO: "Correção de erro"
   TÍTULO MELHOR: "Corrige erro de cálculo na função convert_uf_to_text"

   Lembre-se de sempre ser específico sobre o que foi alterado no título para facilitar a compreensão e a revisão do PR.

   ---

   Hello @, the title of this PR is a bit vague. It's important to have a clear title that briefly explains the purpose of the change. This helps reviewers quickly understand what the PR is about. For example:

   VAGUE TITLE: "Fixing bug"
   BETTER TITLE: "Fixes calculation error in the convert_uf_to_text function"

   Remember to always be specific about what was changed in the title to make the PR easier to understand and review.

2. !bot-caramelo descricao-pr-vaga

   Quando alguém comentar no PR com esse comando, o bot deve comentar uma mensagem explicando que a descrição do PR está pouco detalhada. A mensagem deve marcar a pessoa que criou o PR e oferecer exemplos de como detalhar melhor a descrição, explicando a importância disso.

   Mensagem:

   Olá @, a descrição do PR está um pouco vaga. Uma boa descrição deve explicar claramente o que foi feito, por que foi feito e como pode impactar o projeto. Por exemplo:

   DESCRIÇÃO VAGA: "Adicionando uma nova função"
   DESCRIÇÃO MELHOR: "Adiciona a função convert_uf_to_text para converter códigos de estados em texto por extenso"

   Uma descrição bem detalhada aumenta as chances de revisão eficiente e ajuda a entender o impacto da mudança.

   ---

   Hello @, the PR description is a bit vague. A good description should clearly explain what was done, why it was done, and how it may impact the project. For example:

   VAGUE DESCRIPTION: "Adding a new function"
   BETTER DESCRIPTION: "Adds the convert_uf_to_text function to convert state codes to full text"

   A detailed description increases the chances of efficient review and helps understand the impact of the change.

3. !bot-caramelo faltou-readmes

   Quando alguém comentar no PR com esse comando, o bot deve comentar uma mensagem explicando que o PR não atualizou os arquivos de README, e deve linkar para a documentação que explica como atualizar o README.

   Mensagem:

   Olá @, você esqueceu de atualizar os arquivos README relacionados a essa alteração. Lembre-se de que, para garantir que a documentação esteja sempre atualizada, é necessário modificar os arquivos de README com a descrição das mudanças feitas. Consulte a documentação sobre como atualizar os READMEs para mais detalhes.

   ---

   Hello @, you forgot to update the README files related to this change. Remember that to keep the documentation up to date, you need to modify the README files with the description of the changes made. Check out the documentation on how to update the READMEs for more details.

4. !bot-caramelo faltou-changelog

   Quando alguém comentar no PR com esse comando, o bot deve comentar uma mensagem explicando que o PR não atualizou o changelog e deve linkar para a documentação que explica como adicionar entradas no changelog.

   Mensagem:

   Olá @, você esqueceu de adicionar a entrada no changelog para essa mudança. Lembre-se de que é importante manter o changelog atualizado com todas as alterações significativas no código. Consulte a documentação sobre como adicionar entradas no changelog para mais detalhes.

   ---

   Hello @, you forgot to add an entry to the changelog for this change. Remember that it is important to keep the changelog updated with all significant code changes. Check out the documentation on how to add changelog entries for more details.

Requisitos

• Criar o bot utilizando GitHub Actions que será capaz de enviar as mensagens automatizadas com base nos comandos listados.
• Configurar o bot para marcar a pessoa que criou o PR e enviar as mensagens com exemplos e links para a documentação relevante.
• Testar o bot para garantir que ele está funcionando corretamente em PRs.

Observações

Os nomes dos comandos e as mensagens de exemplo são apenas sugestões. Eles podem ser modificados conforme necessário para melhor atender às necessidades do projeto.