Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
83 lines (54 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

83 lines (54 loc) · 3.39 KB
Raw

参与贡献

感谢你对 PLVS 的兴趣。以下为本地开发与 CI 约定；产品范围与承诺见 docs/prd.md，技术架构见 docs/architecture.md。

环境

  • Node.js：>= 20.19.0（与 package.json 的 engines 一致）
  • Rust：stable（与 src-tauri/Cargo.toml 的 rust-version 一致）
  • FFmpeg sidecar：npm run ffmpeg:fetch。src-tauri/binaries/ 不入库（sidecar 走 Release 资产），新 clone 和新 worktree 都是空的，缺了它 Rust 侧构建会失败——而且报错指向 serde_derive 编译失败这种无关的第三方 crate，真正原因埋在 build script 的输出里。构建流程见 docs/ffmpeg-sidecar-build.md。

常用命令

npm ci
npm run ffmpeg:fetch     # once per clone/worktree: downloads the gitignored FFmpeg sidecars
npm run theme:generate   # optional: regenerates src/generated/theme-fallbacks.css (also runs via prebuild)
npm run lint
npm test
npm run build

桌面端（Tauri）：

npm run desktop

Windows 发布构建（与 CI release.yml 一致：NSIS 安装包 + target/release/app.exe 便携主程序）：

npm run build
npm run desktop:release-nsis

产物：src-tauri/target/release/bundle/nsis/ 下的安装程序，以及 src-tauri/target/release/plvs.exe（便携版依赖本机已安装 WebView2，与安装包相同）。

Rust（在 src-tauri 目录下）：

cd src-tauri
cargo fmt --all -- --check
cargo clippy --all-targets -- -D warnings
cargo test

根目录一键检查 前端 + 版本号 + Rust 格式/静态检查/测试：

npm run check

版本号

发布或 bump 版本时，请同时修改（并保持三者一致）：

  • 根目录 package.json 的 version
  • src-tauri/Cargo.toml 中 [package] 的 version
  • src-tauri/tauri.conf.json 的 version

npm run version:check 会校验上述三处一致；CI 中也会运行。若改了 Cargo.toml 依赖，请在 src-tauri 下执行 cargo check 并视情况提交 Cargo.lock。

Code comments

All comments and docstrings in source code (*.rs, *.js, *.jsx, *.css, etc.) must be English (line/block/JSDoc, Rust /// / //!). String literals that must match localized OS or UI text (e.g. Windows device name heuristics) are exempt.

Git commits and PRs

Use English only for commit messages, PR titles/descriptions, and any text that accompanies git push (no Chinese in those strings).

Changelist (CL) descriptions—the full narrative in a pull request body (or any equivalent review “description” field)—must also be English (what changed, why, risks or follow-ups in clear technical prose).

CI 说明

依赖更新

仓库已启用 Dependabot（npm 与 cargo，每周）。合并前请在本地跑一遍 npm run check。

行尾与编码

仓库使用 LF（见 .editorconfig 与 .gitattributes）。在 Windows 上若 Git 仍提示 CRLF，可执行 git add --renormalize . 一次性规范化。