📖 DOC: Contributing guidelines

Author: msaaddev

.github/scripts/update-examples.ts

@@ -0,0 +1,49 @@
+import {execSync} from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import {fileURLToPath} from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const examplesDir = path.join(__dirname, '..', '..', 'examples');
+
+function installDependencies(packageDir) {
+	console.log(`Installing dependencies in ${packageDir}`);
+	try {
+		execSync('pnpm i langbase@latest', {
+			cwd: packageDir,
+			stdio: 'inherit',
+		});
+		console.log(`Successfully installed dependencies in ${packageDir}`);
+	} catch (error) {
+		console.error(
+			`Error installing dependencies in ${packageDir}:`,
+			error.message,
+		);
+	}
+}
+
+function processExamples() {
+	if (!fs.existsSync(examplesDir)) {
+		console.error('Examples directory not found');
+		return;
+	}
+
+	const entries = fs.readdirSync(examplesDir, {withFileTypes: true});
+
+	for (const entry of entries) {
+		if (entry.isDirectory()) {
+			const packageDir = path.join(examplesDir, entry.name);
+			const packageJsonPath = path.join(packageDir, 'package.json');
+
+			if (fs.existsSync(packageJsonPath)) {
+				installDependencies(packageDir);
+			} else {
+				console.log(`Skipping ${entry.name}: No package.json found`);
+			}
+		}
+	}
+}
+
+processExamples();

CONTRIBUTING.md

@@ -2,11 +2,52 @@
 
 We welcome contributions to this project.
 
+---
+
+## Releasing a snapshot version
+
+To release a snapshot version to test changes, run the following command:
+
+```bash
+npm run snapshot
+```
+
 ## Releasing a new version
 
 ```bash
-# Bug, have to remove example pkg json changes.
 pnpm changeset
-pnpm version-packages && grlz 'new version'
+pnpm version-packages
+grlz 'new version'
 pnpm release
+pnpm update-examples
 ```
+
+## Testing locally
+
+To test the changes locally, you can run the following command:
+
+- Navigate to an example's folder like the Next.js one in `examples/nextjs`.
+
+- Change the `package.json` to point to the local package for `langbase`.
+
+```json
+{
+  "dependencies": {
+    "langbase": "workspace:*"
+  },
+}
+```
+
+- Now run in the root:
+
+```bash
+pnpm clean-all && pnpm install
+```
+
+Then run the development server:
+
+```bash
+pnpm dev
+```
+
+By doing this, the Next.js example will use the local packages instead of the published ones.

package.json

@@ -24,7 +24,8 @@
 		"ci:release": "turbo clean && turbo build && changeset publish",
 		"clean-examples": "node .github/scripts/cleanup-examples-changesets.mjs",
 		"ci:version": "changeset version && node .github/scripts/cleanup-examples-changesets.mjs && pnpm install --no-frozen-lockfile",
-		"snapshot": "node .github/scripts/release-snapshot.js"
+		"snapshot": "node .github/scripts/release-snapshot.js",
+		"update-examples": "npx tsx .github/scripts/update-examples.ts"
 	},
 	"devDependencies": {
 		"@langbase/eslint-config": "workspace:*",