From 0066eab2d999886d980d1f731cc3c5b1e12213ac Mon Sep 17 00:00:00 2001 From: Manfred Moser Date: Fri, 20 Sep 2024 11:18:03 -0700 Subject: [PATCH] Add build and contributing instructions --- README.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/README.md b/README.md index 42ff7e66..1e21b9b5 100644 --- a/README.md +++ b/README.md @@ -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