realpython / realpython/python-guide

Recommend pre-commit in Code Style section

Aperta
#645 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Batchfile
Stelle
29.8k
Fork
5.9k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla sezione Code Style, in particolare dalla discussione di PEP8 e autopep8, e verifica come la guida presenta attualmente gli strumenti per lo stile. Il lavoro è completato quando la sezione illustra chiaramente la raccomandazione proposta per pre-commit e il suo carattere opzionale, mantenendo coerenti le indicazioni esistenti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.