move overloads of execute to @libsql/core/api (because its part of the public API) && add CONTRIBUTING.md #261
+24
−32
better instructions for contribution
commit 92ea842b4b3bce8b971ce9957f8c53c6492a41af
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,13 @@ | ||
| # Prerequisites | ||
|
|
||
| - Have `npm` installed and in PATH | ||
| - Have `git` installed and in PATH | ||
|
|
||
| # Setting up the repo for contributing | ||
|
|
||
| - Clone this repository: `git clone https://github.com/tursodatabase/libsql-client-ts` | ||
| - Change the current working directory to the cloned repository: `cd libsql-client-ts` | ||
| - Install dependencies: `npm i` | ||
| - Change the current working directory to `libsql-core`'s workspace: `cd packages/libsql-core` | ||
| - Built the core package: `npm run build` | ||
| - Go back to the root directory to start making changes: `cd ../..` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think the
\*nixis relevant.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i dont use windows (or haiku or whatever) so i have no knowledge of non *nix
"... for *nix" does not mean not for windows. it simply means that this works for *nix. and does not specify anything for windows, etc
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, I don't think that the *nix is relevant. I don't use windows either but a quick search and from my experience just mentioning the
cdis enough.Below is a rewrite of your instructions with some suggestions to improve clarity. Feel free to copy it completely or update what you think is relevant. I wanted to make sure that each step has a clear description and associated action.