JavaScript style guide for documentation PRs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
- Stack tecnológico
- javascript
- Área
- documentation
Línea de trabajo
Comienza con el cuerpo de la issue y su hilo de 15 comentarios; no se menciona ningún archivo ni ninguna prueba. Determina si la guía de estilo para PRs de documentación tiene un alcance definido y, después, identifica el punto de entrada de la documentación y acuerda las categorías y los ejemplos que constituyen la finalización.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
@zachleat,
Can we drum up a quick style guide for vanilla JS code examples? I'm willing to forego my (otherwise highly opinionated) personal style for a standard.
I can mimic what's already there, but it'd be good to establish something formally—for consistency within the docs (if not also the codebase). Here are the major categories I'm thinking we could use some clear ground rules:
- Ternary operators v. conditional statements?
- Semicolon?
- Closures?
- Explicit
returnstatements? varv.constandlet?- Arrow functions v. declarations v. expressions?
- When and when not to cache variables
- Classes v.
exports.render - Comments and/or JSDoc blocks?
importv.require()this- Others?
I'm convinced more folks would reach for the vanilla 🍦 if they had more examples in the docs—and I wanna help.
- Lenguaje dominante
- Nunjucks
- Estrellas
- 547
- Forks
- 727
- Merge medio
- 7 d 10 h
- PR fusionados (30 d)
- 3
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
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 11ty/docs
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 90/100
-
Suggestion for pagination/"before" documentation: clarify that only js front matter is supportedAbierto
Dificultad 1/5 Menos de una hora Aptitud para principiantes 68/100
-
Liquid "include" tag is deprecatedPosiblemente ocupada @darthmall la tomó hace 453 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 62/100
Issues similares
-
area:docs
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
RailtownAI/railtracks#1633 ·
Los mantenedores suelen responder en 2 días
-
review-panel severity:low
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
kristovatlas/coin-accounting#152 ·
Los mantenedores suelen responder en 1 día
-
documentation :blue_book:
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
PennyLaneAI/pennylane#10280 ·
Los mantenedores suelen responder en 2 días
-
documentation
Dificultad 1/5 Menos de una hora Aptitud para principiantes 95/100
raycast/extensions#32000 ·
Los mantenedores suelen responder en 1 día
-
[Resource]: Claude MonitorAbiertoresource-submission validation-passed
Dificultad 1/5 Menos de una hora Aptitud para principiantes 82/100
hesreallyhim/awesome-claude-code#3096 · 1 comentario ·
Los mantenedores suelen responder en 1 día