Improve the "Making Good PRs" section
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 2.1k
- Fork
- 1k
- Merge medio
- 2g 12h
- PR unite (30g)
- 12
Descrizione
I often see PRs with misleading or vague titles. This is problematic, as the PR titles often end up being the commit titles, and commit titles are one of the most important tools we have when searching for historic changes. Bad titles impact maintainability.
Suggested edits:
- Enforce a strict title format
- Promote writing accurate and concise PR titles/descriptions
Perhaps the "Making Good PRs" section can be further promoted. Would it make sense to extract it and move it a level up in the doc hierarchy?
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la sezione "Making Good PRs" nella guida per sviluppatori e rivedendo la gerarchia della documentazione circostante. Decidi come la sezione dovrebbe trattare i titoli e le descrizioni accurati e concisi delle pull request e se dovrebbe trovarsi a un livello superiore. Il lavoro è completato quando le indicazioni e la loro collocazione riflettono chiaramente i miglioramenti suggeriti dall'issue.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- 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