Define markdown convention/formatting rules
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- markdown
- Área
- ci-cd, documentation
Línea de trabajo
Comienza con CONTRIBUTING.md y un archivo Markdown representativo del repositorio. Compara mdformat, markdownlint, dprint con su plugin de Markdown y Prettier según lo propuesto; después, documenta las convenciones seleccionadas e integra la comprobación elegida en CI para que las futuras salidas de Markdown se comprueben automáticamente.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
It would be good to define our standards/expectations for markdown formatting somewhere consistently.
A good place for this would be CONTRIBUTING.md, but other places could work too.
In addition to introducing documentation on how markdown should be written in the repo, we should probably try and
implement some tooling that enables machines to check our output for us:
- https://github.com/hukkin/mdformat
- https://github.com/DavidAnson/markdownlint
- https://dprint.dev/overview/ w/ https://github.com/dprint/dprint-plugin-markdown
- Prettier (listed last because it's intentionally hard to configure)
I think a good PR that resolves this issue would have a comparison of the output of these tools on one of our files, along with integration of the tool into CI so that we can catch issues going forward.
- Lenguaje dominante
- Rust
- Estrellas
- 138
- Forks
- 89
- Merge medio
- 10 h 38 min
- PR fusionados (30 d)
- 2
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
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 bytecodealliance/component-docs
-
Dificultad 2/5 Medio día Aptitud para principiantes 72/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
-
[FEATURE] Add wasi-cli templatesAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
bytecodealliance/component-docs#294 · 1 comentario ·
-
Add guide for HTTP P3Abiertodocumentation enhancement lang/rust
Dificultad 3/5 1-2 días Aptitud para principiantes 78/100
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
bytecodealliance/component-docs#376 · 1 comentario ·
Todos los issues de bytecodealliance/component-docs
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
security-scan
Dificultad 1/5 Menos de una hora Aptitud para principiantes 85/100
Los mantenedores suelen responder en 1 día
-
content good first issue
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
StudentSuite/awesome-skills-plugins-for-students#293 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
gfx-rs/wgpu-native#636 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Los mantenedores suelen responder en 1 día