Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Add hook usage examples as jsdoc/tsdoc

Aperta
#2,492 0 commenti 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
react, typescript

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
TypeScript
Stelle
44k
Fork
3.3k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di streamich/react-use

Tutte le issue di streamich/react-use

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.