nushell / nushell/nushell.github.io

The contributing notes for the nu website is missing a style guide

Abierto
#1,085 0 comentarios 2 reacciones 0 asignados Ver en GitHub

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:

  1. Code examples should use the nu formatting as in ```nu , currently this is not very consistent as I see none, bash, sh, nu and nushell used. I think it would be nice to have these consisten.
  2. 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

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. 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

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.