Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (22 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 1.17 KB

Contributing

We welcome contributions to this project.

Repl

For quick troubleshooting, there is a repl available by running npm run repl. This will start a Node.js repl with the @pinecone-io/client package preloaded. The npm command runs the file utils/replInit.ts.

Local testing

To run all tests locally, excluding the unit tests, you will need to set your Pinecone API key to an environment variable (or hard-code it in a .env file in this repo).

You can retrieve your API key from app.pinecone.io.

export PINECONE_API_KEY=your_api_key

To see the exact commands run by the aliases mentioned in this doc, see the scripts section in the package.json file.

Unit tests

Simply run npm run test:unit to run all unit tests.

Integration tests

Simply run npm run test:integration-local:<runtime> to run all integration tests, substituting <runtime> with either node or edge as you see fit.

External app tests

Simply run npm run test:external-app-local to run all tests that integrate with the ts-client-test-external-app repo:

The npm command runs the bash file located in the src/external-app directory.