nushell / nushell/nushell.github.io
The contributing notes for the nu website is missing a style guide
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 258
- Forks
- 561
- Merge medio
- 3 h 20 min
- PR fusionados (30 d)
- 15
Descripción
It would also be nice to add some style guides for contributing to the book. Currently the style of e.g. code examples is a bit inconsistent. For example:
- Code examples should use the nu formatting as in
```nu, currently this is not very consistent as I seenone,bash,sh,nuandnushellused. I think it would be nice to have these consisten. - Another that might be nice is to use a consistent style for output formating of tables. E.g. "examples of table output should use rounded corners" (don't actually mean it needs to be rounded, just that we would use a consistent styling"
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.
Línea de trabajo
Empieza por localizar las notas para contribuir al sitio web y el contenido del libro que abarcan. Documenta etiquetas coherentes para los bloques de código de Nu y un único estilo para la salida de tablas; después, revisa los ejemplos circundantes para asegurarte de que las instrucciones sean claras y aplicables.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- shell
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 50/100