From e4d4e0d024cc4b240f0cd42b86d62a2d9a91ae55 Mon Sep 17 00:00:00 2001 From: Marcus Schiesser <mail@marcusschiesser.de> Date: Thu, 25 Jul 2024 09:59:45 +0200 Subject: [PATCH] docs: update CONTRIBUTING.md (#1073) --- CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b08dcdf9e..37a8a847f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,11 @@ This is a monorepo built with Turborepo -Right now there are two packages of importance: +Right now, for first-time contributors, these three packages are of the highest importance: -packages/llamaindex which is the main NPM library llamaindex - -examples is where the demo code lives +- `packages/llamaindex` which is the main NPM library `llamaindex` +- `examples` is where the demo code lives +- `apps/docs` is where the code for the documentation of https://ts.llamaindex.ai/ is located ### Turborepo docs @@ -43,11 +43,11 @@ pnpm run test To write new test cases write them in [packages/llamaindex/tests](/packages/llamaindex/tests) -We use Jest https://jestjs.io/ to write our test cases. Jest comes with a bunch of built in assertions using the expect function: https://jestjs.io/docs/expect +We use Vitest https://vitest.dev to write our test cases. Vitest comes with a bunch of built-in assertions using the expect function: https://vitest.dev/api/expect.html#expect ### Demo applications -There is an existing ["example"](/examples/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the core package with a new demo, you need to run the build command in the README. +There is an existing ["example"](/examples/README.md) demos folder with mainly NodeJS scripts. Feel free to add additional demos to that folder. If you would like to try out your changes in the `llamaindex` package with a new demo, you need to run the build command in the README. You can create new demo applications in the apps folder. Just run pnpm init in the folder after you create it to create its own package.json @@ -81,7 +81,7 @@ Any changes you make should be reflected in the browser. If you need to regenera ## Changeset -We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run: +We use [changesets](https://github.com/changesets/changesets) for managing versions and changelogs. To create a new changeset, run in the root folder: ``` pnpm changeset -- GitLab