Clean up README
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 38/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Stack technique
- javascript
- Domaine
- documentation
Piste de recherche
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.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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
- Langage dominant
- JavaScript
- Étoiles
- 11.5k
- Forks
- 992
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de debug-js/debug
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
-
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
-
Debug as JSON Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
-
console.group and groupCollapsed Ouverte
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
-
Difficulté 3/5 1-2 jours Accessibilité débutants 28/100
Toutes les issues de debug-js/debug
Issues similaires
-
Update HugeIcons library Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
antfu-collective/icones#398 ·
-
ECmail.com Ouverte
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
wesbos/burner-email-providers#554 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
radiantearth/stac-browser#1023 ·
-
HMR stops working Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
components-web-app/docs#92 ·