Add docs for specific helpers

Abierto
  • ¿Algo no está bien?
#722 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@thatblindgeye ya está trabajando en esto.

Desde el 10/1/2025.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

codemod documentation PF Team post v6

It'd be advantageous to add some documentation for some of our more prominent helpers for contributors who don't frequent this repo as often. Essentially just including info for:

  • what the helper is called

  • what it's for/what it does (sentence or two)

  • maybe some example code logic to show how it's most often used in the codebase

  • whether it's intended to be used inline (e.g. within a node block), as a context report, or passed as a reference to the create property of the rule (e.g. renameProps)

Jira Issue: PF-1066

Lenguaje dominante
TypeScript
Estrellas
13
Forks
20
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 patternfly/pf-codemods

Todos los issues de patternfly/pf-codemods

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.