Clarify Ruff installation requirement before running lint commands

Aperta
#738 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

Direzione di ricerca

Apri la README e trova la sezione “Running Code Style Checks”. Controlla i comandi Ruff esistenti, quindi aggiungi prima di essi un breve prerequisito di installazione usando il percorso delle dipendenze documentato dal progetto. Il lavoro è completato quando un nuovo collaboratore può installare Ruff e seguire le istruzioni di lint senza dover tirare a indovinare.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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!

Lingua principale
Jupyter Notebook
Stelle
5.2k
Fork
5.3k
Merge medio
4g 10h
PR unite (30g)
10

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di realpython/materials

Tutte le issue di realpython/materials

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.