Clean up README
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 38/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- JavaScript
- Estrellas
- 11.5k
- Forks
- 992
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de debug-js/debug
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 25/100
-
Debug as JSON Abierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
console.group and groupCollapsed Abierto
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 28/100
Todos los issues de debug-js/debug
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
mksglu/context-mode#1200 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
neondatabase/website#5944 ·
-
module: core
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
bigbluebutton/bigbluebutton#25849 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
jaegertracing/jaeger-ui#4506 ·