Recommend pre-commit in Code Style section
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 35/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par la section Code Style, en particulier par sa présentation de PEP8 et autopep8, et examinez comment le guide présente actuellement les outils de style. La tâche est terminée lorsque la section couvre clairement la recommandation proposée pour pre-commit et son caractère facultatif, tout en conservant la cohérence des indications existantes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
The Code Style section discusses the use of PEP8 and autopep8. Yelp's pre-commit framework allows you to formalise the use of PEP8 in a project by ensuring that PEP8/PyFlakes is run on Python code (as well as equivalent tools for other languages like JSHint). Pre-commit is not mandatory: it is something which individual developers on a project can install if they feel like it - the pre-commit framework simply allows you to share around a common set of pre-commit scripts in a sensible way.
If it is desirable to follow "Pythonicity" in a project, it is probably a good idea to suggest people enforce it at the level of version control.
If there's interest in this, I can draft some text for inclusion and submit a PR.
- Langage dominant
- Batchfile
- Étoiles
- 29.8k
- Forks
- 5.9k
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Ouvrir le 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/python-guide
-
Page 404 error Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 65/100
realpython/python-guide#1104 · 2 commentaires ·
-
Difficulté 1/5 1-3 heures Accessibilité débutants 62/100
realpython/python-guide#327 ·
-
PyZMQ improvements Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 62/100
realpython/python-guide#326 · 5 commentaires ·
-
@alex Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
realpython/python-guide#1194 ·
-
Development Team SAP Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
realpython/python-guide#1192 ·
Toutes les issues de realpython/python-guide
Issues similaires
-
Add: hunch Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
-
A11y ♿️
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
Link Checker Report Ouverteautomated issue report
Difficulté 2/5 1-3 heures Accessibilité débutants 85/100
-
documentation improve or update documentation priority/low triage
Difficulté 2/5 Une demi-journée Accessibilité débutants 86/100
warpdotdev/docs#782 · 1 commentaire ·