realpython / realpython/python-guide
Recommend pre-commit in Code Style section
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Batchfile
- Sterne
- 29.8k
- Forks
- 5.9k
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
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
Beginne mit dem Abschnitt Code Style, insbesondere mit der Erörterung von PEP8 und autopep8, und überprüfe, wie der Leitfaden derzeit Tools für den Code-Stil darstellt. Erledigt ist die Aufgabe, wenn der Abschnitt die vorgeschlagene Empfehlung für pre-commit und deren optionalen Charakter klar abdeckt und die bestehende Anleitung weiterhin schlüssig bleibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 35/100