Skip to content

Commit 4af6d63

Browse files
committed
Add build and contributing instructions
1 parent 3bef09f commit 4af6d63

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,37 @@ const data: QueryData[] = await iter
7272
More usage examples can be found in the
7373
[integration tests](https://github.com/trinodb/trino-js-client/blob/main/tests/it/client.spec.ts).
7474

75+
## Build
76+
77+
Use the following commands to build the project locally with your modifications,
78+
and in preparation to contribute a pull request.
79+
80+
Requirements:
81+
82+
* yarn
83+
84+
Install dependencies:
85+
86+
```shell
87+
yarn install --frozen-lockfile
88+
```
89+
90+
Lint the source code:
91+
92+
```shell
93+
yarn test:lint
94+
```
95+
96+
Build
97+
98+
```shell
99+
yarn build
100+
```
101+
102+
## Contributing
103+
104+
Follow the [Trino contribution guidelines](https://trino.io/development/process)
105+
and contact us on Slack and GitHub.
106+
75107
Copyright
76108
[Trino JS Client contributors](https://github.com/trinodb/trino-js-client/graphs/contributors) 2022-present

0 commit comments

Comments
 (0)