realpython / realpython/materials
Clarify Ruff installation requirement before running lint commands
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.2k
- Forks
- 5.3k
- Ø Merge
- 4 T. 10 Std.
- Gemergte PRs (30 T.)
- 10
Beschreibung
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!
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Öffne die README und finde den Abschnitt “Running Code Style Checks”. Prüfe die vorhandenen Ruff-Befehle und füge davor eine kurze Installationsvoraussetzung hinzu, die den in der Projektdokumentation beschriebenen Abhängigkeitspfad verwendet. Erledigt, wenn ein neuer Mitwirkender Ruff installieren und den Lint-Anweisungen folgen kann, ohne raten zu müssen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 55/100