feat: 初始化 GPU Monitor 项目
搭建基于 Flask + SocketIO 的 GPU 集群实时监控系统,包含远程采集、定时调度、Web 前端可视化及项目文档。
这个提交包含在:
+55
@@ -0,0 +1,55 @@
|
||||
# 贡献指南 (Contributing)
|
||||
|
||||
感谢你考虑为 **GPU Monitor** 做出贡献!本文档说明如何参与本项目。
|
||||
|
||||
## 行为准则
|
||||
|
||||
请在所有交流中保持友善、尊重与包容。我们致力于为所有人提供友好的协作环境。
|
||||
|
||||
## 如何贡献
|
||||
|
||||
### 报告问题 (Bug Report)
|
||||
|
||||
如果你发现了 Bug,请先搜索 [Issues](../../issues) 确认是否已被报告。若没有,请新建 Issue 并提供:
|
||||
|
||||
- 清晰的问题描述与复现步骤
|
||||
- 操作系统、Python 版本、依赖版本 (`pip freeze`)
|
||||
- 相关日志或截图
|
||||
- 期望行为与实际情况
|
||||
|
||||
### 功能建议 (Feature Request)
|
||||
|
||||
欢迎提出新功能建议。请描述使用场景与期望效果,便于社区讨论。
|
||||
|
||||
### 提交代码 (Pull Request)
|
||||
|
||||
1. Fork 本仓库并克隆到本地。
|
||||
2. 基于 `master` 分支创建特性分支:
|
||||
```bash
|
||||
git checkout -b feature/your-feature-name
|
||||
```
|
||||
3. 安装开发依赖并确保代码可运行:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
python app.py
|
||||
```
|
||||
4. 请确保:
|
||||
- 不提交任何敏感信息(如真实 IP、密码、`config.yaml`)。
|
||||
- 新增依赖需同步更新 `requirements.txt`。
|
||||
- 代码风格保持与现有代码一致(4 空格缩进、清晰的英文/中文注释)。
|
||||
5. 提交信息清晰描述改动(建议使用 Conventional Commits,如 `feat:`, `fix:`, `docs:`)。
|
||||
6. 推送分支并发起 Pull Request,描述改动内容与测试情况。
|
||||
|
||||
## 开发规范
|
||||
|
||||
- **配置安全**:所有示例配置使用 `config.example.yaml`,真实配置放 `config.yaml`(已被忽略)。
|
||||
- **密钥管理**:严禁硬编码任何密钥 / 密码,统一通过环境变量读取。
|
||||
- **代码质量**:保持函数职责单一,关键逻辑添加注释。
|
||||
|
||||
## 许可证
|
||||
|
||||
提交贡献即表示你同意你的贡献在 [MIT License](LICENSE) 下授权。
|
||||
|
||||
---
|
||||
|
||||
再次感谢你的贡献!🎉
|
||||
在新工单中引用
屏蔽一个用户