- Set up your environment as described in the root level README.
- Pinecone personnel: Ensure you have access to this repository and the necessary credentials for local development.
- From the root of the repository, navigate to your app directory:
cd apps/pinecone
(or the appropriate path). - Run
npm install
to install dependencies (commit the generatedpackage-lock.json
). - Make your app changes as needed.
- Run
npm test
(orvitest
) to execute unit tests. These tests use mocks and do not make live API calls. - Bump the version in
package.json
using SemVer for versioning. - Add a changelog entry for your new version.
- Open a pull request and follow the test and deploy instructions.
- When running or developing locally, use your own Pinecone API key for any manual API tests. Do not commit or share API keys.
- All automated tests are fully mocked and do not require a live Pinecone account.