Clean up README
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 38/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- javascript
- Ambito
- documentation
Direzione di ricerca
Start with the repository README and compare its current structure with the requested sections: one screenshot, title and summary, installation, basic usage, API documentation, examples, Open Collective, and license. Remove redundant examples, explanations, and screenshots while preserving the listed content. Done means the README is concise and contains the requested single screenshot and sections.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Debug has a simple API with a handful of static-/member-methods. It has been relatively unchanged since its conception (yes, users of 0.x can most likely upgrade to the latest major without any problems).
However, the README currently reflects a manual (nay, a bible) of integrated examples, etc. for a library that should be easily grok-able in just a few moments' time.
Not every method call needs three examples, nor does it need several paragraphs explaining the intricacies of how the method is useful.
Further, the use of screenshots is egregious. They add several pagefuls of redundant information.
Let's minimize the README to just:
- Single screenshot (very top, centered)
- Title; summary
- Installation
- Basic usage
- API documentation
- Examples
- Open Collective et al
- License
- Lingua principale
- JavaScript
- Stelle
- 11.5k
- Fork
- 992
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
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.
Altre issue di debug-js/debug
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 82/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 25/100
-
Debug as JSON Aperta
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 28/100
Tutte le issue di debug-js/debug
Issue simili
-
Update HugeIcons library Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
antfu-collective/icones#398 ·
-
ECmail.com Aperta
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
wesbos/burner-email-providers#554 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
components-web-app/docs#92 ·