Clarify Ruff installation requirement before running lint commands
Maintainer antworten meist innerhalb von 5 Tagen
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Anfängerfreundlichkeit
- 55/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- python
- Bereich
- documentation
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.
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!
- Vorherrschende Sprache
- Jupyter Notebook
- Sterne
- 5.2k
- Forks
- 5.3k
- Ø Merge
- 5 T. 2 Std.
- Gemergte PRs (30 T.)
- 11
Entwicklungsumgebung
- Kein Dockerfile und keine Docker-Compose-Datei
- Hat eine Pull-Request-Vorlage
- Kein Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus realpython/materials
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
realpython/materials#729 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
пOffen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 1/100
realpython/materials#763 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 45/100
realpython/materials#737 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
проект2Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 15/100
realpython/materials#725 ·
Maintainer antworten meist innerhalb von 5 Tagen
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 15/100
realpython/materials#721 ·
Maintainer antworten meist innerhalb von 5 Tagen
Alle Issues in realpython/materials
Ähnliche Issues
-
Messenger
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 62/100
symfony/symfony-docs#23237 ·
Maintainer antworten meist innerhalb von 3 Tagen
-
sync-en
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
Maintainer antworten meist innerhalb von 1 Tag
-
sync-en
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 4 Tagen
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 66/100
rescript-lang/rescript-lang.org#1420 ·
Maintainer antworten meist innerhalb von 2 Tagen
-
Documentation Feature: Financial
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
Maintainer antworten meist innerhalb von 1 Tag