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.

Sign up for GitHub

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

Jump to bottom

Add build and contributing instructions #661

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Add build and contributing instructions #661

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,5 +72,37 @@ const data: QueryData[] = await iter
More usage examples can be found in the
[integration tests](https://github.com/trinodb/trino-js-client/blob/main/tests/it/client.spec.ts).

## Build

Use the following commands to build the project locally with your modifications,
and in preparation to contribute a pull request.

Requirements:

* yarn

Install dependencies:

```shell
yarn install --frozen-lockfile
```

Lint the source code:

```shell
yarn test:lint
```

Build

```shell
yarn build
```

## Contributing

Follow the [Trino contribution guidelines](https://trino.io/development/process)
and contact us on Slack and GitHub.

Copyright
[Trino JS Client contributors](https://github.com/trinodb/trino-js-client/graphs/contributors) 2022-present