Skip to content

Commit 3aba1a5

Browse files
authored
update contributing doc (#30)
1 parent 236569b commit 3aba1a5

2 files changed

Lines changed: 34 additions & 1 deletion

File tree

‎CONTRIBUTING.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## Contributing
2+
3+
### Development install
4+
5+
- Create a Conda environment
6+
7+
```bash
8+
mamba create -n specta-dev python nodejs jupyterlab "jupyterlite-core>=0.7.0" "jupyterlite-xeus>=4.0.0"
9+
mamba activate specta-dev
10+
```
11+
12+
- Install `specta` in editable mode
13+
14+
```bash
15+
pip install -e .
16+
```
17+
18+
- Build and serve the demo
19+
20+
```bash
21+
npm run build:demo
22+
cd demo
23+
python -m http.server -d _output
24+
```
25+
26+
- After changing the source, rebuild the app and the extension then update the demo
27+
28+
```bash
29+
npm run build:all:dev
30+
npm run update:demo
31+
```
32+
33+
Calling `update:demo` instead of `build:demo` is faster as it does not rebuild the JupyterLite instance.

‎pyproject.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ build_cmd = "build:all"
6767
npm = ["npm"]
6868

6969
[tool.hatch.build.hooks.jupyter-builder.editable-build-kwargs]
70-
build_cmd = "install:extension"
70+
build_cmd = "build:all:dev"
7171
npm = ["npm"]
7272
source_dir = "src"
7373
build_dir = "specta/labextension"

0 commit comments

Comments
 (0)