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

Issue 407 #439

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

FloraSauerbronn
Copy link

@FloraSauerbronn FloraSauerbronn commented Oct 22, 2024

Adiciona uso sugerido do comando pip na documentação

Descrição

Resolvendo o issue de documentação de instalação com pip

Mudanças Propostas

Adicionei a sessão de instalação com pip nos arquivos CONTRIBUTING.md e CONTRIBUTING_EN.md
Criei um requirements-dev.txt, pois não foi possível realizar a instalação das dependencias somente utilizando o pyproject.toml.

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)

Segue esse link de um post da comunidade python justificando meu PR
Why doesn’t pip write installed packages to pyproject.toml?

Issue Relacionada

Issue 407

Closes #407

@FloraSauerbronn FloraSauerbronn requested review from a team as code owners October 22, 2024 17:12
Copy link

codecov bot commented Oct 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.78%. Comparing base (4af1cdc) to head (a9955b5).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #439   +/-   ##
=======================================
  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.

Copy link
Contributor

@melissawm melissawm left a comment

Choose a reason for hiding this comment

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

Oi @FloraSauerbronn ! Uma dica, coloque um título descritivo na sua PR pra aumentar as chances de revisão (tipo "Adiciona uso sugerido do comando pip na documentação")

Aí, na descrição da PR vc pode usar um dos atalhos do github tipo Closes #407 pra ligar sua PR à issue original, e fechar a issue automaticamente quando sua PR for mesclada.

De resto, tá ótimo 😄

@FloraSauerbronn
Copy link
Author

@melissawm obrigada pelas dicas ! Ficarei atenta.

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.

Ajuste no processo de instalação
2 participants