26 行
975 B
Markdown
26 行
975 B
Markdown
# 贡献指南
|
||
|
||
感谢关注本项目！欢迎通过 Issue 反馈问题、通过 Pull Request 提交改进。
|
||
|
||
## 提交 Issue
|
||
|
||
- 反馈 Bug 时请附上：复现步骤、期望行为、实际行为、运行环境（操作系统 / Python 版本 / Docker 版本）
|
||
- **注意脱敏**：不要在 Issue 中粘贴真实的服务器 IP、账号、密码或日志中的敏感信息
|
||
|
||
## 提交 Pull Request
|
||
|
||
1. Fork 本仓库并创建功能分支：
|
||
```bash
|
||
git checkout -b feature/your-feature
|
||
```
|
||
2. 保持改动聚焦，一个 PR 只解决一类问题
|
||
3. 提交前自查：
|
||
- 代码无语法错误（`python -m py_compile app.py test.py`）
|
||
- 不引入任何硬编码的 IP / 账号 / 密码
|
||
- 涉及配置的改动需同步更新 `.env.example` 与 `readme.md`
|
||
4. 提交信息使用约定式格式，如 `feat: xxx`、`fix: xxx`、`docs: xxx`、`chore: xxx`
|
||
|
||
## 安全问题
|
||
|
||
请勿通过公开 Issue 报告安全漏洞，参见 [SECURITY.md](SECURITY.md)。
|