Clarify Ruff installation requirement before running lint commands

Aberta
#738 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
1/5
Tempo estimado
Menos de uma hora
Facilidade para iniciantes
55/100
Tipo de issue
Documentação
Clareza
Razoavelmente clara
Status de atividade
Estagnada
Stack de tecnologia
python
Domínio
documentation

Direção de pesquisa

Abra a README e encontre a seção “Running Code Style Checks”. Verifique os comandos Ruff existentes e, em seguida, adicione antes deles um breve pré-requisito de instalação usando o caminho de dependências documentado pelo projeto. Está concluído quando um novo colaborador puder instalar o Ruff e seguir as instruções de lint sem precisar adivinhar.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

Hi 👋,

In the "Running Code Style Checks" section of the README, contributors are instructed to run:

However, it may not be immediately clear to new contributors that Ruff needs to be installed first.

Would it be helpful to briefly mention how to install Ruff (for example via pip or from requirements.txt) before running these commands?

Happy to open a PR with a suggested clarification if this sounds reasonable.

Thanks!

Linguagem predominante
Jupyter Notebook
Estrelas
5.2k
Forks
5.3k
Merge médio
4d 10h
PRs com merge (30d)
10

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de realpython/materials

Todas as issues de realpython/materials

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.