Merge pull request #867 from porink0424/fix/contribution-md

Update `CONTRIBUTING.md`
This commit is contained in:
c-bata
2024-04-19 17:36:09 +09:00
committed by GitHub
7 changed files with 66 additions and 10 deletions
+12 -2
View File
@@ -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.
+4 -1
View File
@@ -60,7 +60,10 @@
"name": "@optuna/types",
"version": "0.0.1",
"dev": true,
"license": "MIT"
"license": "MIT",
"devDependencies": {
"typescript": "^5.4.5"
}
},
"node_modules/@ampproject/remapping": {
"version": "2.3.0",
+8 -2
View File
@@ -43,19 +43,25 @@
}
},
"../storage": {
"name": "@optuna/storage",
"version": "0.0.1",
"license": "MIT",
"dependencies": {
"@sqlite.org/sqlite-wasm": "^3.45.1-build1"
},
"devDependencies": {
"@optuna/types": "../types/"
"@optuna/types": "../types/",
"typescript": "^5.4.5"
}
},
"../types": {
"name": "@optuna/types",
"version": "0.0.1",
"dev": true,
"license": "MIT"
"license": "MIT",
"devDependencies": {
"typescript": "^5.4.5"
}
},
"node_modules/@adobe/css-tools": {
"version": "4.3.3",
+19 -2
View File
@@ -12,7 +12,8 @@
"@sqlite.org/sqlite-wasm": "^3.45.1-build1"
},
"devDependencies": {
"@optuna/types": "../types/"
"@optuna/types": "../types/",
"typescript": "^5.4.5"
}
},
"../entity": {
@@ -25,7 +26,10 @@
"name": "@optuna/types",
"version": "0.0.1",
"dev": true,
"license": "MIT"
"license": "MIT",
"devDependencies": {
"typescript": "^5.4.5"
}
},
"node_modules/@optuna/types": {
"resolved": "../types",
@@ -38,6 +42,19 @@
"bin": {
"sqlite-wasm": "bin/index.js"
}
},
"node_modules/typescript": {
"version": "5.4.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
"integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
"dev": true,
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
},
"engines": {
"node": ">=14.17"
}
}
}
}
+2 -1
View File
@@ -26,6 +26,7 @@
"@sqlite.org/sqlite-wasm": "^3.45.1-build1"
},
"devDependencies": {
"@optuna/types": "../types/"
"@optuna/types": "../types/",
"typescript": "^5.4.5"
}
}
+17 -1
View File
@@ -7,7 +7,23 @@
"": {
"name": "@optuna/types",
"version": "0.0.1",
"license": "MIT"
"license": "MIT",
"devDependencies": {
"typescript": "^5.4.5"
}
},
"node_modules/typescript": {
"version": "5.4.5",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.4.5.tgz",
"integrity": "sha512-vcI4UpRgg81oIRUFwR0WSIHKt11nJ7SAVlYNIu+QpqeyXP+gpQJy/Z4+F0aGxSE4MqwjyXvW/TzgkLAx2AGHwQ==",
"dev": true,
"bin": {
"tsc": "bin/tsc",
"tsserver": "bin/tsserver"
},
"engines": {
"node": ">=14.17"
}
}
}
}
+4 -1
View File
@@ -19,5 +19,8 @@
"bugs": {
"url": "https://github.com/optuna/optuna-dashboard/issues"
},
"homepage": "https://github.com/optuna/optuna-dashboard#readme"
"homepage": "https://github.com/optuna/optuna-dashboard#readme",
"devDependencies": {
"typescript": "^5.4.5"
}
}