Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Document best practices when adding images to documentation

Abierto
#153 1 comentario 0 reacciones 0 asignados Ver en GitHub

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
Necesita aclaración
Estado de actividad
Estancado
Área
cli, documentation

Línea de trabajo

No se nombran archivos, pruebas ni un punto de entrada de CLI; empieza por localizar la sección de la documentación sobre imágenes y cualquier herramienta existente para reducir el tamaño de las imágenes. Se considera terminado cuando la documentación cubra la elección del formato, la reducción del tamaño, el uso de pre-commit y los nombres, y documente claramente el comportamiento y el uso del comando de CLI solicitado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

images

Some obvious steps would be:

  1. Document how to choose an appropriate image format (JPG, PNG).
  2. Add CLI command that automatically reduces size of images.
  3. Document how to apply it before adding images to git history.
  4. Document how to sensibly name images.
Lenguaje dominante
TypeScript
Estrellas
15
Forks
46
Merge medio
1 d 21 h
PR fusionados (30 d)
1

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Más de oasisprotocol/docs

Todos los issues de oasisprotocol/docs

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.