README Formatting suggestion
Nessuno ha ancora preso questa issue.
- Lingua principale
- JavaScript
- Stelle
- 11.8k
- Fork
- 7.9k
- Merge medio
- 1g 11h
- PR unite (30g)
- 11
Descrizione
The README is comprehensive and helpful, and could be even better served if at the top of the README there was a row of all the major header (perhaps even linked to jump the the part of the page it references), and a description of aforementioned headers so that users could more easily navigate it, especially for newcomers.
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 aprendo il README del repository e rivedi le intestazioni principali e la struttura già presenti. Aggiungi vicino all'inizio una riga collegata con quelle intestazioni e brevi descrizioni, quindi verifica che ogni collegamento porti alla sezione prevista e che il README rimanga leggibile per chi è alle prime armi.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 1/5
- Tempo stimato
- 1-3 ore
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100