obsidian-plugin/fancive_obsidian-parallel-reader
1
0
Fork 0
mirror of https://github.com/fancive/obsidian-parallel-reader.git synced 2026-07-22 06:53:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: document e2e contract gate

Browse source 
Change-Id: I940bac18e567c55a7cd57e1ccf37203f871c6aec
This commit is contained in:
wujunchen 2026-04-29 14:09:55 +08:00
parent 970a7bc364
commit 57c1c0e124
3 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.e2e/README.md
View file

@ -7,9 +7,12 @@ The runner clears stale artifacts, executes the real `npm test` gate, records
Run the host-neutral gate with:
```bash
E2E_CONTRACT_VALIDATOR_PYTHONPATH=/Users/wujunchen/dev/github.com/fancive/claude-code-addons/scripts \
bash .e2e/gate.sh --json
```
If `e2e_contract_validator` is not installed, set
`E2E_CONTRACT_VALIDATOR_PYTHONPATH` to the `claude-code-addons/scripts`
directory before running the gate.
Generated artifacts under `.e2e/artifact.json` and `.e2e/results/` are runtime
evidence and are intentionally ignored by git.

8
README.md
View file

@ -111,6 +111,14 @@ npm run lint # Biome
npm test # build + typecheck + tests
```
The project also has a host-neutral e2e contract gate:
```bash
bash .e2e/gate.sh --json
```
If `e2e_contract_validator` is not installed, set `E2E_CONTRACT_VALIDATOR_PYTHONPATH` to the `claude-code-addons/scripts` directory before running the gate. Runtime evidence such as `.e2e/artifact.json` and `.e2e/results/` is generated locally and ignored by git.
## Star History
<a href="https://www.star-history.com/#fancive/obsidian-parallel-reader&Date">

8
README.zh-CN.md
View file

@ -111,6 +111,14 @@ npm run lint # Biome
npm test # 构建 + 类型检查 + 测试
```
项目还提供一个与宿主环境解耦的 e2e contract gate：
```bash
bash .e2e/gate.sh --json
```
如果本机没有安装 `e2e_contract_validator`，运行前把 `E2E_CONTRACT_VALIDATOR_PYTHONPATH` 指向 `claude-code-addons/scripts` 目录。`.e2e/artifact.json`、`.e2e/results/` 等运行证据只在本地生成，并已被 git 忽略。
## Star History
<a href="https://www.star-history.com/#fancive/obsidian-parallel-reader&Date">