reactjs / reactjs/react-docgen
Extract comments from `defaultProps`
Aperta
Nessuno ha ancora preso questa issue.
- Lingua principale
- TypeScript
- Stelle
- 3.8k
- Fork
- 316
- Merge medio
- 5h 7m
- PR unite (30g)
- 4
Descrizione
In our component library, a lot of comments are historically made on defaultProps not on propTypes. It would be nice if react-docgen could catch them as well
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
La issue non indica file, test o un punto di ingresso. Inizia individuando come react-docgen estrae i commenti da propTypes e come viene gestito defaultProps, quindi esegui i test di estrazione esistenti; il lavoro è completato quando i commenti scritti in defaultProps sono inclusi nella documentazione generata del componente.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- react, typescript
- Ambito
- documentation
- Tipo di issue
- Funzionalità
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Stato di attività
- Ferma
- Chiarezza
- Da chiarire
- Idoneità per principianti
- 30/100