move overloads of execute to @libsql/core/api (because its part of the public API) && add CONTRIBUTING.md #261
Conversation
|
some auto linting scripts (present in this repo) seem to have linted the migrate method right before git push |
|
Thanks for working on these changes! They look good to me so I’m going to allow GitHub actions to run! Anyways, looks good to me! |
|
Just read your comment sorry. We setup the repository so it runs prettier before pushing your changes so all of our code is formatted following the same rules. Seems that not all files are formatted though as commented in #256 so it would be nice if you can run |
i originally didnt run this because this might've changed many files and that would've looked suspicious |
|
No problem, thanks for running it! Otherwise we may have issues with the rest of the active pull requests. |
CONTRIBUTING.md
Outdated
| - have `npm` installed and in path | ||
| - have `git` installed and in path |
There was a problem hiding this comment.
| - have `npm` installed and in path | |
| - have `git` installed and in path | |
| - have `npm` installed and in PATH | |
| - have `git` installed and in PATH |
There was a problem hiding this comment.
In that case, I think the convention is $PATH no?
There was a problem hiding this comment.
AFAIK $PATH is only valid for Unix system. Windows GUI says Path but in cmd you can do echo %PATH%.
Thus my suggestion to just use PATH everywhere.
It's a nit pick anyway so feel free to ignore it.
There was a problem hiding this comment.
Sounds good to me then!
There was a problem hiding this comment.
I also think that this is a good opportunity to capitalize the instructions and leave a single space after each dash instead of four.
| - have `npm` installed and in path | |
| - have `git` installed and in path | |
| - Have `npm` installed and in PATH | |
| - Have `git` installed and in PATH |
CONTRIBUTING.md
Outdated
| - have `npm` installed and in path | ||
| - have `git` installed and in path | ||
|
|
||
| # Setting up the repo for contributing |
There was a problem hiding this comment.
I don't think the \*nix is relevant.
There was a problem hiding this comment.
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.
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 cd is 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.
| # Setting up the repo for contributing | |
| # 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 ../..` |
CONTRIBUTING.md
Outdated
| - have `npm` installed and in path | ||
| - have `git` installed and in path |
There was a problem hiding this comment.
Sounds good to me then!
CONTRIBUTING.md
Outdated
| - have `npm` installed and in path | ||
| - have `git` installed and in path | ||
|
|
||
| # Setting up the repo for contributing |
There was a problem hiding this comment.
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 cd is 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.
| # Setting up the repo for contributing | |
| # 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 ../..` |
CONTRIBUTING.md
Outdated
| - have `npm` installed and in path | ||
| - have `git` installed and in path |
There was a problem hiding this comment.
I also think that this is a good opportunity to capitalize the instructions and leave a single space after each dash instead of four.
| - have `npm` installed and in path | |
| - have `git` installed and in path | |
| - Have `npm` installed and in PATH | |
| - Have `git` installed and in PATH |
move overloads of execute to @libsql/core/api (because its part of the public API)
and
add CONTRIBUTING.md to provide instructions to setup repo for experimentation and contribution