reactjs / reactjs/react-docgen
Extract comments from `defaultProps`
Abierto
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 3.8k
- Forks
- 316
- Merge medio
- 5 h 7 min
- PR fusionados (30 d)
- 4
Descripción
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
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
El issue no indica archivos, pruebas ni un punto de entrada. Empieza por localizar cómo react-docgen extrae los comentarios de propTypes y cómo se gestionan defaultProps; después, ejecuta las pruebas de extracción existentes. La tarea está terminada cuando los comentarios escritos en defaultProps se incluyen en la documentación del componente generada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- react, typescript
- Área
- documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 30/100