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 local development instructions to README #39

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

shinshin86
Copy link

This PR adds a new "Development" section to the README, providing step-by-step instructions for building and testing sqlc-gen-typescript locally. These additions aim to:

  1. Guide developers through the process of local setup and testing
  2. Lower the barrier to entry for potential contributors

By making the development process more transparent and accessible, we hope to encourage more developers to contribute to this project.

@shinshin86
Copy link
Author

I overlooked that the build process was already defined in the Makefile.
Therefore, I've updated the WASM build instructions to reference the Makefile.
Additionally, I've corrected the wasm file specification which previously assumed an absolute path with file:///.
These changes should make the development process clearer and more flexible for contributors.

@yshrsmz
Copy link
Contributor

yshrsmz commented Oct 4, 2024

Maybe we should add a link to the core sqlc development guide
https://docs.sqlc.dev/en/latest/guides/development.html

@shinshin86
Copy link
Author

@yshrsmz
Thank you for your valuable feedback! I've added a link to the core sqlc development guide as per your suggestion.
If you have any further suggestions or feedback, please let me know. Thanks again!

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.

2 participants