Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for specific helpers #722

Open
thatblindgeye opened this issue Jul 30, 2024 · 0 comments
Open

Add docs for specific helpers #722

thatblindgeye opened this issue Jul 30, 2024 · 0 comments
Labels
codemod documentation Improvements or additions to documentation post v6

Comments

@thatblindgeye
Copy link
Collaborator

thatblindgeye commented Jul 30, 2024

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)
@thatblindgeye thatblindgeye added documentation Improvements or additions to documentation codemod labels Jul 30, 2024
@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Issues Jul 30, 2024
@tlabaj tlabaj added the post v6 label Aug 22, 2024
@tlabaj tlabaj moved this from Needs triage to Backlog in PatternFly Issues Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codemod documentation Improvements or additions to documentation post v6
Projects
Status: Backlog
Development

No branches or pull requests

2 participants