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

chore(docs): add setup guide #54

Merged
merged 4 commits into from
Aug 14, 2024
Merged

Conversation

Jay-Karia
Copy link
Contributor

This PR adds setup guide for local development and instructions for how to test new changes made during development.

Closes #52

@nebrelbug
Copy link
Owner

I'm not completely convinced that this is necessary, I think people could probably figure this out on their own.

@Jay-Karia
Copy link
Contributor Author

Jay-Karia commented Aug 8, 2024

It was a bit difficult for me to figure out how to test new changes made in the code, for that I had to go through Rollup docs. So I thought adding a section might help others.

This could improve DX

If you are fine without it, I am ready to close this

@nebrelbug
Copy link
Owner

@Jay-Karia actually as I think about it, this might be helpful. Could you just rename the section to "Contributing to npm-to-yarn - Setup Guide" or something like that to clarify that it's for development of npm-to-yarn, not using npm-to-yarn?

@Jay-Karia
Copy link
Contributor Author

@nebrelbug,
Implemented changes

@nebrelbug
Copy link
Owner

@Jay-Karia sweet, merging now

@nebrelbug nebrelbug merged commit c06d07c into nebrelbug:master Aug 14, 2024
4 checks passed
@Jay-Karia Jay-Karia deleted the docs/setup-guide branch August 14, 2024 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing Setup Guide in README
2 participants