mirror of
https://github.com/LHY0125/PathEditor.git
synced 2026-06-28 17:25:54 +08:00
Serendipity
21af2683ac
## 审查修复 (18 项)
- TitleBar 版本号改为动态 import package.json
- CLI profile_apply 加 verify_and_save 原子性保护
- CLI 新增 profile rename 子命令
- cmd_clean 默认清理 system+user 两个 hive
- Rust import_csv 加 BOM/header 处理
- exportToJson/exportToCsv 保留 enabled 状态
- CLI version 使用 env!("CARGO_PKG_VERSION")
- export_paths 返回 Result, 未知格式报错
- importFromContent 未知扩展名 throw Error
- profile 文件名加路径遍历/Win保留字校验
- 数据路径统一到 ~/.patheditor/
## clippy (18 处修复)
- backup/scanner/system/profiles: empty_line_after_doc_comments
- profiles: needless_borrow ×5, unnecessary_map_or
- scanner: collapsible_if
- cli: nonminimal_bool ×6, implicit_saturating_sub, to_string_in_format_args
- 零警告通过
## 测试 (33 条新增)
- Rust: backup(3) + disabled(1) + fs(13) + scanner(4) + profiles(1) = 25 条
- 前端: merge-preview(2) + analyze-dialog(1) + import-parity(5) = 8 条
- Rust 10→35, 前端 72→80
## Scanner 并行化
- std::thread::scope 多线程并行扫描目录，N 倍性能提升
## expand_env_vars UTF-16 修复
- 非法码点编码为 \u{XXXX} 而非静默丢弃
## 开源标配
- CODE_OF_CONDUCT.md (Contributor Covenant 2.1)
- SECURITY.md (漏洞报告流程)
- .github/PULL_REQUEST_TEMPLATE.md
- CONTRIBUTING.md (贡献指南)
- CHANGELOG.md (v4.0~v5.0)
## E2E 测试 (4 条新增)
- keyboard / analyze / profiles / import-export
- IPC mock 扩展 scan/profiles 命令
## CI
- Rust job 目录调整为 workspace 根
## 其他
- rustdoc: 8 个 pub fn 补文档注释
- 帮助文本 v4.0→v5.0
- 前后端导入逻辑加交叉引用注释
- .gitignore 添加 target/
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
75 lines
1.4 KiB
Markdown
75 lines
1.4 KiB
Markdown
# 贡献指南
|
|
|
|
## 本地开发环境
|
|
|
|
- **Node.js** 22+
|
|
- **Rust** 1.95+ (stable-x86_64-pc-windows-gnu)
|
|
- **MinGW-w64** (GCC 15.x 需 `-lmcfgthread` 链接标志)
|
|
- **Windows 10+** (自带 WebView2)
|
|
|
|
## 开发流程
|
|
|
|
1. Fork 本仓库
|
|
2. `git clone <你的 fork>`
|
|
3. `git checkout -b feature/xxx`
|
|
4. 开发 + 测试
|
|
5. `git commit` (遵循约定式提交格式)
|
|
6. `git push`
|
|
7. 提交 Pull Request
|
|
|
|
## 运行测试
|
|
|
|
```bash
|
|
# 前端单元测试
|
|
npm test
|
|
|
|
# Rust 测试
|
|
cargo test
|
|
|
|
# E2E 测试 (需要先 npm run dev)
|
|
npx playwright test
|
|
|
|
# Clippy 检查
|
|
cargo clippy -- -D warnings
|
|
```
|
|
|
|
## 代码规范
|
|
|
|
### TypeScript
|
|
|
|
- `strict: true`，零编译错误
|
|
- 核心逻辑在 `src/core/`，纯函数，零框架依赖
|
|
- 不可变操作优先
|
|
|
|
### Rust
|
|
|
|
- 所有 `pub fn` 必须有 `///` 文档注释
|
|
- 所有 `unsafe` 块必须有 `// SAFETY:` 注释
|
|
- `cargo clippy -- -D warnings` 零警告
|
|
- `cargo fmt` 统一格式
|
|
|
|
## 提交格式
|
|
|
|
```
|
|
<类型>: <描述>
|
|
```
|
|
|
|
类型：`feat`, `fix`, `refactor`, `docs`, `test`, `chore`, `perf`, `ci`
|
|
|
|
## 项目结构
|
|
|
|
```
|
|
core/ # Rust 核心库（零 Tauri 依赖）
|
|
gui/ # Tauri 桌面应用
|
|
cli/ # 命令行工具
|
|
src/ # React 前端
|
|
tests/unit/ # 前端单元测试
|
|
e2e/ # Playwright E2E 测试
|
|
```
|
|
|
|
## 开始贡献前
|
|
|
|
- 大改动建议先开 Issue 讨论
|
|
- 新功能需要对应的测试
|
|
- 不要引入新的 clippy 警告
|