realpython / realpython/materials
Clarify Ruff installation requirement before running lint commands
Nessuno ha ancora preso questa issue.
- Lingua principale
- Jupyter Notebook
- Stelle
- 5.2k
- Fork
- 5.3k
- Merge medio
- 4g 10h
- PR unite (30g)
- 10
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!
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
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.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- Meno di un'ora
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 55/100