Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebase #3

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Rebase #3

merged 2 commits into from
Jan 31, 2025

Conversation

tiagornandrade
Copy link
Owner

@tiagornandrade tiagornandrade commented Jan 31, 2025

Descrição

Mudanças Propostas

Checklist de Revisão

  • Eu li o Contributing.md
  • Os testes foram adicionados ou atualizados para refletir as mudanças (se aplicável).
  • Foi adicionada uma entrada no changelog / Meu PR não necessita de uma nova entrada no changelog.
  • A documentação em português foi atualizada ou criada, se necessário.
  • Se feita a documentação, a atualização do arquivo em inglês.
  • Eu documentei as minhas mudanças no código, adicionando docstrings e comentários. Instruções
  • O código segue as diretrizes de estilo e padrões de codificação do projeto.
  • Todos os testes passam. Instruções
  • O Pull Request foi testado localmente. Instruções
  • Não há conflitos de mesclagem.

Comentários Adicionais (opcional)

Issue Relacionada

Closes #<numero_da_issue>

Resumo por Sourcery

Adicionar um bot de inatividade para fechar automaticamente pull requests inativos e uma seção de contribuidores nos arquivos README.

CI:

  • Adicionar uma ação do GitHub para marcar pull requests inativos.

Documentação:

  • Adicionar uma seção de contribuidores nos arquivos README.
Original summary in English

Summary by Sourcery

Add a stale bot to automatically close stale pull requests and a contributors section to the README files.

CI:

  • Add a GitHub action to mark stale pull requests.

Documentation:

  • Add a contributors section to the README files.

Copy link

sourcery-ai bot commented Jan 31, 2025

Guia do Revisor por Sourcery

Este pull request introduz uma nova seção nos arquivos README que exibe uma lista de contribuidores do projeto e adiciona um workflow para marcar pull requests obsoletos.

Diagrama de sequência para workflow de PR obsoleto

sequenceDiagram
    participant GH as GitHub Actions
    participant PR as Pull Request
    participant C as Contributors

    Note over GH: Tarefa cron diária às 00:00 UTC
    GH->>PR: Verificar última atividade do PR
    alt PR inativo por 60+ dias
        GH->>PR: Adicionar label 'Obsoleto'
        GH->>PR: Adicionar mensagem de aviso
        alt Sem atividade por mais 7 dias
            GH->>PR: Fechar PR
            GH->>PR: Adicionar mensagem de fechamento
        else PR atualizado
            GH->>PR: Remover label 'Obsoleto'
        end
    end
Loading

Mudanças em Nível de Arquivo

Mudança Detalhes Arquivos
Adicionada seção de contribuidores nos arquivos README.
  • Adicionada nova seção para exibir lista de contribuidores.
  • Adicionado link para o gráfico de contribuidores.
  • Adicionada nota indicando que a seção foi criada com contrib.rocks.
README.md
README_EN.md
Adicionado workflow para marcar pull requests obsoletos.
  • Adicionado novo arquivo de workflow.
  • Configurado workflow para executar diariamente.
  • Configurado workflow para marcar pull requests como obsoletos após 60 dias de inatividade.
  • Configurado workflow para fechar pull requests obsoletos após 7 dias de marcação.
  • Adicionada mensagem a ser exibida quando um pull request for marcado como obsoleto.
  • Adicionada mensagem a ser exibida quando um pull request for fechado devido à inatividade.
  • Configurado workflow para isentar pull requests com a label 'keep-open'.
  • Configurado workflow para remover a label de obsoleto quando um pull request for atualizado.
.github/workflows/stale.yml

Dicas e comandos

Interagindo com Sourcery

  • Disparar uma nova revisão: Comente @sourcery-ai review no pull request.
  • Continuar discussões: Responda diretamente aos comentários de revisão do Sourcery.
  • Gerar um issue do GitHub a partir de um comentário de revisão: Peça ao Sourcery para criar um issue a partir de um comentário de revisão respondendo a ele. Você também pode responder a um comentário de revisão com @sourcery-ai issue para criar um issue.
  • Gerar título de pull request: Escreva @sourcery-ai em qualquer lugar no título do pull request para gerar um título a qualquer momento. Você também pode comentar @sourcery-ai title no pull request para (re-)gerar o título a qualquer momento.
  • Gerar resumo de pull request: Escreva @sourcery-ai summary em qualquer lugar no corpo do pull request para gerar um resumo de PR exatamente onde você quiser. Você também pode comentar @sourcery-ai summary no pull request para (re-)gerar o resumo a qualquer momento.
  • Gerar guia do revisor: Comente @sourcery-ai guide no pull request para (re-)gerar o guia do revisor a qualquer momento.
  • Resolver todos os comentários do Sourcery: Comente @sourcery-ai resolve no pull request para resolver todos os comentários do Sourcery. Útil se você já tratou todos os comentários e não quer mais vê-los.
  • Dispensar todas as revisões do Sourcery: Comente @sourcery-ai dismiss no pull request para dispensar todas as revisões existentes do Sourcery. Especialmente útil se você quiser começar do zero com uma nova revisão - não se esqueça de comentar @sourcery-ai review para disparar uma nova revisão!
  • Gerar um plano de ação para um issue: Comente @sourcery-ai plan em um issue para gerar um plano de ação para ele.

Personalizando sua Experiência

Acesse seu painel para:

  • Ativar ou desativar recursos de revisão como resumo de pull request gerado pelo Sourcery, guia do revisor e outros.
  • Alterar o idioma de revisão.
  • Adicionar, remover ou editar instruções de revisão personalizadas.
  • Ajustar outras configurações de revisão.

Obtendo Ajuda

Original review guide in English

Reviewer's Guide by Sourcery

This pull request introduces a new section to the README files that displays a list of contributors to the project, and adds a workflow to mark stale pull requests.

Sequence diagram for stale PR workflow

sequenceDiagram
    participant GH as GitHub Actions
    participant PR as Pull Request
    participant C as Contributors

    Note over GH: Daily cron job at 00:00 UTC
    GH->>PR: Check PR last activity
    alt PR inactive for 60+ days
        GH->>PR: Add 'Stale' label
        GH->>PR: Add warning message
        alt No activity for 7 more days
            GH->>PR: Close PR
            GH->>PR: Add closure message
        else PR updated
            GH->>PR: Remove 'Stale' label
        end
    end
Loading

File-Level Changes

Change Details Files
Added a contributors section to the README files.
  • Added a new section to display a list of contributors.
  • Added a link to the contributors graph.
  • Added a note indicating the section was made with contrib.rocks.
README.md
README_EN.md
Added a workflow to mark stale pull requests.
  • Added a new workflow file.
  • Configured the workflow to run daily.
  • Configured the workflow to mark pull requests as stale after 60 days of inactivity.
  • Configured the workflow to close stale pull requests after 7 days of being marked as stale.
  • Added a message to be displayed when a pull request is marked as stale.
  • Added a message to be displayed when a pull request is closed due to inactivity.
  • Configured the workflow to exempt pull requests with the 'keep-open' label.
  • Configured the workflow to remove the stale label when a pull request is updated.
.github/workflows/stale.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Olá @tiagornandrade - Revisei suas alterações e elas estão ótimas!

Aqui está o que analisei durante a revisão
  • 🟡 Questões gerais: 2 problemas encontrados
  • 🟢 Segurança: tudo parece bom
  • 🟢 Testes: tudo parece bom
  • 🟢 Complexidade: tudo parece bom
  • 🟢 Documentação: tudo parece bom

Sourcery é gratuito para código aberto - se você gostou de nossas revisões, considere compartilhá-las ✨
Ajude-me a ser mais útil! Por favor, clique 👍 ou 👎 em cada comentário para que eu possa usar o feedback para melhorar suas revisões.
Original comment in English

Hey @tiagornandrade - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

## ❤️ Quem já Contribuiu

<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sugestão: Considere adicionar texto alternativo (alt text) à imagem para acessibilidade.

Texto alternativo descritivo melhora a acessibilidade para usuários que não podem ver a imagem.

Suggested change
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" alt="Mosaico de avatares dos contribuidores do projeto brutils-python" />
Original comment in English

suggestion: Consider adding alt text to the image for accessibility.

Descriptive alt text improves accessibility for users who cannot see the image.

Suggested change
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" alt="Mosaico de avatares dos contribuidores do projeto brutils-python" />

Comment on lines +1293 to +1294
<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sugestão: Considere adicionar texto alternativo (alt text) à imagem para acessibilidade.

Texto alternativo descritivo melhora a acessibilidade para usuários que não podem ver a imagem.

Suggested change
<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" alt="Grade de imagens de avatar mostrando todos os contribuidores do projeto" />
Original comment in English

suggestion: Consider adding alt text to the image for accessibility.

Descriptive alt text improves accessibility for users who cannot see the image.

Suggested change
<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" />
<a href="https://github.com/brazilian-utils/brutils-python/graphs/contributors">
<img src="https://contrib.rocks/image?repo=brazilian-utils/brutils-python" alt="Grid of avatar images showing all project contributors" />

@tiagornandrade tiagornandrade merged commit b7d7a86 into tiagornandrade:main Jan 31, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants