Clarify Ruff installation requirement before running lint commands
Les mainteneurs répondent en général sous 5 jours
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 1/5
- Temps estimé
- Moins d'une heure
- Accessibilité débutants
- 55/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Ouvrez la README et trouvez la section “Running Code Style Checks”. Vérifiez les commandes Ruff existantes, puis ajoutez avant celles-ci un bref prérequis d’installation utilisant le chemin de dépendances documenté du projet. Le travail est terminé lorsqu’un nouveau contributeur peut installer Ruff et suivre les instructions de lint sans avoir à deviner.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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!
- Langage dominant
- Jupyter Notebook
- Étoiles
- 5.2k
- Forks
- 5.3k
- Merge moyen
- 5 j 2 h
- PR mergées (30 j)
- 11
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Aucun guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de realpython/materials
-
Ruff lints the whole repoOuverte
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
realpython/materials#729 ·
Les mainteneurs répondent en général sous 5 jours
-
пOuverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 1/100
realpython/materials#763 ·
Les mainteneurs répondent en général sous 5 jours
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 45/100
realpython/materials#737 ·
Les mainteneurs répondent en général sous 5 jours
-
проект2Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 15/100
realpython/materials#725 ·
Les mainteneurs répondent en général sous 5 jours
-
pip install -r requirements.txtOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 15/100
realpython/materials#721 ·
Les mainteneurs répondent en général sous 5 jours
Toutes les issues de realpython/materials
Issues similaires
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 78/100
pyca/verified-garbage#1023 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
quickemu-project/quickemu#1960 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
-
area/docs
Difficulté 1/5 Moins d'une heure Accessibilité débutants 88/100
Les mainteneurs répondent en général sous 1 jour