chore: 前端工程化 + Git hooks + 对齐 PathEditor 规范
- 新增 .gitattributes(CRLF 统一)+ rust-toolchain.toml - 新增 Prettier + ESLint + markdownlint 配置 - 新增 Husky Git hooks(pre-commit lint-staged + commit-msg commitlint) - 新增 vitest 前端测试(12 tests, utils/qrText.ts) - 新增 @ 路径别名(vite + tsconfig) - 新增 ROADMAP / SUPPORT / CODEOWNERS / FUNDING / dependabot - 更新 .gitignore + .editorconfig - 更新 package.json(新增 lint/format/test 脚本) - 全项目 prettier 格式化 + eslint 通过 - 更新 CLAUDE.md + README.md
This commit is contained in:
+71
@@ -0,0 +1,71 @@
|
||||
# 获取帮助
|
||||
|
||||
## 📖 文档
|
||||
|
||||
- [README](README.md) — 项目简介、功能列表、安装指南
|
||||
- [CONTRIBUTING](CONTRIBUTING.md) — 贡献指南
|
||||
- [CHANGELOG](CHANGELOG.md) — 版本变更记录
|
||||
- [ROADMAP](ROADMAP.md) — 未来规划
|
||||
- [SECURITY](SECURITY.md) — 安全政策
|
||||
|
||||
## 🐛 报告 Bug
|
||||
|
||||
1. 先搜索 [Issues](https://github.com/LHY0125/QRGen/issues) 确认未被报告
|
||||
2. 使用 **Bug Report** 模板创建新 Issue
|
||||
3. 提供系统信息(OS 版本、Rust 版本、QRGen 版本)
|
||||
4. 附上复现步骤和截图
|
||||
|
||||
## 💡 功能建议
|
||||
|
||||
1. 检查 [ROADMAP](ROADMAP.md) 确认不在已有计划中
|
||||
2. 使用 **Feature Request** 模板创建新 Issue
|
||||
3. 描述使用场景和期望行为
|
||||
|
||||
## ❓ 常见问题
|
||||
|
||||
### CLI 命令找不到?
|
||||
|
||||
```bash
|
||||
qrgen --help
|
||||
```
|
||||
|
||||
确保已通过 `cargo build --release -p qrgen` 编译,可执行文件在 `target/release/qrgen.exe`。
|
||||
|
||||
### QR 码扫不出来?
|
||||
|
||||
1. 确保静区边距足够(推荐 `--margin 4` 或更大)
|
||||
2. 确保纠错级别适合(H 级可容忍更大遮挡)
|
||||
3. 检查打印/显示尺寸 — 太小的 QR 码可能无法对焦
|
||||
|
||||
### PNG 输出空白?
|
||||
|
||||
```bash
|
||||
# 增大模块尺寸
|
||||
qrgen "Hello" -o qr.png -s 8
|
||||
```
|
||||
|
||||
默认模块尺寸较小(2px),增大 `-s` 参数可获得更大图片。
|
||||
|
||||
### Web 服务怎么后台运行?
|
||||
|
||||
```bash
|
||||
# Docker
|
||||
docker run -d --name qrgen-web --restart unless-stopped -p 3000:3000 qrgen-web
|
||||
|
||||
# 或使用 docker-compose
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
### 生成超大 QR 码(版本 40)失败?
|
||||
|
||||
```bash
|
||||
# 降低纠错级别获取更多容量
|
||||
qrgen "very long text..." -l L -o qr.png
|
||||
```
|
||||
|
||||
版本 40-L 可容纳约 7089 个数字或 4296 个字母。
|
||||
|
||||
## 📧 联系
|
||||
|
||||
- GitHub Issues: [LHY0125/QRGen](https://github.com/LHY0125/QRGen/issues)
|
||||
- 安全问题: 参见 [SECURITY.md](SECURITY.md)
|
||||
Reference in New Issue
Block a user