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

Add hook usage examples as jsdoc/tsdoc

Abierto
#2,492 0 comentarios 2 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
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
react, typescript

Línea de trabajo

Review the repository's hook source and existing documentation to determine which hooks need examples and where their JSDoc or TSDoc belongs. Add brief usage examples or documentation links so they appear when hovering over each hook in an IDE, then verify the rendered documentation for the covered hooks.

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

Descripción

Is your feature request related to a problem? Please describe.
To see examples for usage of a particular hook one needs to come to this repo taking them out of their flow.

image

Describe the solution you'd like
Examples and brief documentation should be in jsdoc/tsdoc format so that hook usage examples can be viewed in IDE by hovering over the hook.

image

Describe alternatives you've considered
Alternatively, just provide a link to the documentation for the hook

If I can get approval for this I'm happy to open a PR and contribute this.

Lenguaje dominante
TypeScript
Estrellas
44k
Forks
3.3k
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

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 streamich/react-use

Todos los issues de streamich/react-use

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.