Skip to content

Commit 64073c9

Browse files
committed
📖 DOC: Local contribution
1 parent 5ed6d62 commit 64073c9

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

‎CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,38 @@
22

33
We welcome contributions to this project.
44

5+
---
6+
57
## Releasing a new version
68

79
```bash
810
pnpm changeset
911
pnpm version-packages && grlz 'new version'
1012
pnpm release
1113
```
14+
## Testing locally
15+
16+
To test the changes locally, you can run the following command:
17+
18+
- Use an example like the Next.js one
19+
- Change the `package.json` to point to the local package for `baseai` and `@baseai/core` packages.
20+
21+
```json
22+
{
23+
"dependencies": {
24+
"@baseai/core": "workspace:*"
25+
},
26+
"devDependencies": {
27+
"baseai": "workspace:*"
28+
}
29+
}
30+
```
31+
32+
Now run in the root `pnpm clean-all && pnpm install` and then run `pnpm dev` to start the development server.
33+
34+
By doing this, the Next.js app will use the local packages instead of the published ones.
35+
36+
---
1237

1338
## Docs
1439

0 commit comments

Comments
 (0)