Contributing to spice.js

Requirements

NodeJS 18 or 20
Docker
Yarn (npm install -g yarn)

Developing

The development branch is trunk. This is the branch that all pull requests should be made against.

To develop locally:

Fork this repository to your own GitHub account and then clone it to your local device.
Create a new branch:
```
git checkout -b MY_BRANCH_NAME
```
Install the dependencies with:
```
yarn install
```
To run the tests, create a .env file with your Spice.ai API Key:
```
API_KEY=<Spice.ai API Key>
```
Run the tests with:
```
make test
```