Skip to content

Commit 6953de9

Browse files
committed
docs: add concise contribution guidance
1 parent b0beea8 commit 6953de9

3 files changed

Lines changed: 30 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,16 @@ Read scientific documents in any language, with realtime translation, on any pla
7676

7777
## Development
7878

79+
<details>
80+
<summary>Contributing</summary>
81+
82+
- **Tooling:** Bun manages dependencies and scripts; Vue/Vite build the UI, while Electron and Express run on Node.js. Commit `bun.lock` when changing dependencies.
83+
- **Tests:** run `bun run build`, then `bun run test`; CI scripts use `node --test .github/scripts/*.test.*`. Add focused regression coverage for behavior changes; see [test priorities](doc/testing.md).
84+
- **CI:** **Code style** checks formatting and lint; **Packaging** builds and launches apps on macOS, Windows and Linux. **Release** publishes successful default-branch packages when the version increases.
85+
- **Style:** run `bun run style:fix` before committing. Husky automatically formats and checks staged files, blocking unresolved errors. Prettier/ESLint cover JS and Vue, Ruff covers Python, and swift-format covers Swift; see [setup and rules](doc/code-style.md).
86+
87+
</details>
88+
7989
<details>
8090
<summary>Local development</summary>
8191

‎doc/README.ja.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,16 @@
7676

7777
## 開発
7878

79+
<details>
80+
<summary>コントリビュート</summary>
81+
82+
- **ツール:** Bun で依存関係とスクリプトを管理し、Vue/Vite で UI を構築します。Electron と Express は Node.js で動作します。依存関係を変更したら `bun.lock` もコミットしてください。
83+
- **テスト:** `bun run build` の後に `bun run test` を実行します。CI スクリプトは `node --test .github/scripts/*.test.*` で検証します。動作変更には対象を絞った回帰テストを追加してください。[テスト方針](testing.md)を参照。
84+
- **CI:** **Code style** が書式と lint を検証し、**Packaging** が macOS・Windows・Linux でビルドと起動を確認します。**Release** はバージョン更新時にデフォルトブランチの成功したビルドを公開します。
85+
- **コードスタイル:** コミット前に `bun run style:fix` を実行してください。Husky がステージ済みファイルを自動整形・検証し、未解決のエラーがあるとコミットを停止します。JS/Vue は Prettier/ESLint、Python は Ruff、Swift は swift-format を使います。[セットアップと規則](code-style.md)を参照。
86+
87+
</details>
88+
7989
<details>
8090
<summary>ローカル開発</summary>
8191

‎doc/README.zh-CN.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,16 @@
7676

7777
## 开发
7878

79+
<details>
80+
<summary>贡献说明</summary>
81+
82+
- **脚手架:** Bun 管理依赖与脚本,Vue/Vite 构建界面,Electron 和 Express 使用 Node.js。依赖变更时同步提交 `bun.lock`。
83+
- **测试:** 先运行 `bun run build`,再运行 `bun run test`;CI 脚本测试用 `node --test .github/scripts/*.test.*`。行为变更应补充针对性的回归测试,参见[测试原则](testing.md)。
84+
- **CI:** **Code style** 检查格式与 lint;**Packaging** 在 macOS、Windows、Linux 构建并启动应用;**Release** 在版本递增后发布默认分支构建成功的安装包。
85+
- **代码风格:** 提交前运行 `bun run style:fix`。Husky 会自动格式化并检查暂存文件,未解决的错误阻止提交。JS/Vue 使用 Prettier/ESLint,Python 使用 Ruff,Swift 使用 swift-format,参见[工具安装与规则](code-style.md)。
86+
87+
</details>
88+
7989
<details>
8090
<summary>本地开发</summary>
8191

0 commit comments

Comments
 (0)