391

[laistdomiciano]

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 #391

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (3f0d528) to head (f8b6b82).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #418   +/-   ##
=======================================
  Coverage   99.78%   99.78%           
=======================================
  Files          18       18           
  Lines         472      472           
=======================================
  Hits          471      471           
  Misses          1        1           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[antoniamaia]

uauuu @laistdomiciano amei seu PR! Obrigada pela sua contribuição!! Comentei alguns pequenos detalhes que encontrei, @camilamaia agora é contigo!! :)

[camilamaia]

Excelente PR! Amei as melhorias no inglês, ficaram ótimos!

Algumas dicas na hora da criação do PR (acho que inclusive podemos colocar essas dias no guia depois):

• Colocar um nome descritivo no PR facilita para quem tá revisando saber exatamente do que se trata, sem precisar ir procurar a issue. Exemplo 391 Atualizando versão em inglês do arquivo de contribuição
• Adicionar uma descrição no PR acaba também facilitando para quem revisa. Eu sei que pode parecer meio repetitivo, mas às vezes ajuda a pessoa revisora a pegar algum detalhe.
  Ex:

A [versão em português do arquivo de contribuição](https://github.com/brazilian-utils/brutils-python/blob/main/CONTRIBUTING.md) foi atualizada nos PRs https://github.com/brazilian-utils/brutils-python/pull/390 e https://github.com/brazilian-utils/brutils-python/pull/401, porém a [versão em inglês](https://github.com/brazilian-utils/brutils-python/blob/main/CONTRIBUTING_EN.md) ainda não foi.

Esse PR provê a atualização do guia de contribuição versão inglês.

• No GitHub, se você escrever closes #<número_da_issue>, quando o PR for mergeado, automaticamente a issue também é fechada.
  https://docs.github.com/pt/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue
  Por isso, no nosso template de PR, tem a seção Issue Relacionada.

Então é sempre legal atualizar o número da issue ali, para habilitar essa automação. Exemplo: closes #391

[camilamaia]

@laistdomiciano engraçado, as modificações que eu sugeri não foram atualizadas.

Exemplo:

• o comando oi do makefile ainda está lá
• os links para o github essentials também ainda se encontram lá

Você tentou arrumar na sua máquina e fazer um novo commit/push? Caso precise de ajuda, podemos fazer um pair!

[laistdomiciano]

@camilamaia espero que agora esteja correto 🙂

[camilamaia]

Opa, mandou bem tirando o Makefile! Aeaaeaee!

Só duas refs ao github essentials que ficaram. Já comentei com a sugestão.

[camilamaia]

Ops, vi que tem uns links apontando para doc em PT-BR. Comentei ali com a sugestão também!

[camilamaia]

UHULLLL! Primeiro de muitos 🙌

[antoniamaia]

Parabéns, @laistdomiciano!! 🎉 O primeiro a gente não esquece ❤️