Update CONTRIBUTING.md

optuna · Apr 19, 2024 · 8bcb125 · 8bcb125
1 parent 5d6e7be
commit 8bcb125
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 3 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -15,12 +15,22 @@ The repository is organized as follows:
 │   ├── browser_app_entry.tsx   # Entry point for browser app, hosted on GitHub pages.
 │   └── vscode_entry.tsx        # Entry point for VS Code app, output placed under `vscode/assets`.
 ├── vscode/             # The VS Code extension.
-└── rustlib/            # Rust library exporting Wasm functions.
-    └── pkg/            # Output directory for rustlib, installed from package.json via `"./rustlib/pkg"`.
+├── rustlib/            # Rust library exporting Wasm functions.
+│   └── pkg/            # Output directory for rustlib, installed from package.json via `"./rustlib/pkg"`.
+└── tslib/              # TypeScript library shared for common use.
+    ├── react/                  # Common React components.
+    ├── storage/                # Common code for handling storage.
+    └── types/                  # Common TypeScript types.
 ```
 
 ## Python package
 
+#### Building TypeScript packages
+
+```
+$ make tslib
+```
+
 #### Compiling TypeScript files
 
 Node.js v16 is required to compile TypeScript files.

diff --git a/optuna_dashboard/package-lock.json b/optuna_dashboard/package-lock.json