renjue
f1502ed08c
CI / docker (push) Successful in 11m42s
Co-authored-by: Cursor <cursoragent@cursor.com>
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# 贡献指南
|
||
|
||
感谢你对 ToolBox 的关注！欢迎通过 Issue 或 Pull Request 参与贡献。
|
||
|
||
## 开始之前
|
||
|
||
1. 搜索 [Issues](https://git.rc707blog.top/rose_cat707/ToolBox/issues)，确认是否已有相关讨论
|
||
2. 较大改动请先开 Issue 说明方案，避免重复劳动
|
||
|
||
## 本地开发
|
||
|
||
```bash
|
||
git clone https://git.rc707blog.top/rose_cat707/ToolBox.git
|
||
cd ToolBox
|
||
npm install
|
||
npm run dev
|
||
```
|
||
|
||
## 代码规范
|
||
|
||
- 遵循项目现有风格，改动范围尽量小
|
||
- 业务逻辑优先放在 `src/utils/`，便于单元测试
|
||
- 不要提交 `node_modules`、`dist`、密钥或 `.env` 等敏感文件
|
||
|
||
## 测试
|
||
|
||
提交前请确保测试通过：
|
||
|
||
```bash
|
||
npm run test:run
|
||
npm run build
|
||
```
|
||
|
||
新增功能或修复 bug 时，请补充或更新 `tests/` 下对应测试。
|
||
|
||
## 提交 Pull Request
|
||
|
||
1. Fork 仓库并创建功能分支（如 `feat/xxx`、`fix/xxx`）
|
||
2. 编写清晰的 commit message，说明「为什么」而不只是「改了什么」
|
||
3. 确保 CI 通过（npm test + Docker 构建）
|
||
4. 在 PR 描述中说明改动内容、测试方式
|
||
|
||
## 报告问题
|
||
|
||
- Bug：请提供复现步骤、期望行为与实际行为
|
||
- 功能建议：说明使用场景与预期效果
|
||
- 安全漏洞：请参见 [SECURITY.md](./SECURITY.md)，勿在公开 Issue 中披露细节
|