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

Example in transform files #201

Open
RupenAnjaria opened this issue Feb 14, 2018 · 7 comments
Open

Example in transform files #201

RupenAnjaria opened this issue Feb 14, 2018 · 7 comments
Assignees

Comments

@RupenAnjaria
Copy link

Just like https://github.com/reactjs/react-codemod/blob/master/transforms/manual-bind-to-arrow.js
file has comment on top to show what will be the impact of transformation by before and after codes, can we please update other JS files with comments to show before and after codeblocks?

@threepointone
Copy link
Contributor

I'll accept a PR.

@muescha
Copy link

muescha commented Aug 9, 2019

Also in the README would be nice

@alex-saunders
Copy link

Hey @threepointone , is this issue still free to take?

@threepointone
Copy link
Contributor

Assigned to you! Take your time with this. Maybe a good idea to add a TOC to the README too, since this will make it quite chunky. Happy to discuss if you have questions.

@alex-saunders
Copy link

Thanks! I'll get working on this right away.
Good shout about a contents in the README, I'll add that as well.

@muescha
Copy link

muescha commented Oct 29, 2019

to avoid out of sync comments maybe it's better only in the:
a) transformation file or
b) the readme file
should be the impact example code?

@threepointone
Copy link
Contributor

threepointone commented Oct 29, 2019

Only in the README file, I think. And it doesn’t have to be exhaustive (if there are options), just a simple example will do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants