feat: 初始化自动控制原理AI+数智平台项目

- 添加时域分析、频域分析、根轨迹分析功能
- 集成 AI 智能问答(DeepSeek/Gemini API)
- 现代化 UI 设计,支持 LaTeX 公式渲染
- 完整的项目文档和配置文件
This commit is contained in:
2025-10-15 20:37:30 +08:00
parent 9b4b3072a5
commit 7edbda02f6
8 changed files with 979 additions and 0 deletions
+171
View File
@@ -0,0 +1,171 @@
# 贡献指南
感谢您对本项目的关注!我们欢迎任何形式的贡献。
## 🤝 如何贡献
### 报告 Bug
如果您发现了 Bug,请:
1. 在 [Issues](https://github.com/your-repo/issues) 中搜索是否已有相同问题
2. 如果没有,创建新 Issue,包含:
- 清晰的标题
- Bug 复现步骤
- 预期行为 vs 实际行为
- 系统环境(操作系统、Python 版本等)
- 错误截图或日志(如果有)
### 提出新功能
如果您有新功能建议:
1. 创建 Feature Request Issue
2. 描述功能的用途和价值
3. 提供可能的实现思路(可选)
### 提交代码
#### 准备工作
1. Fork 本仓库
2. 克隆到本地:
```bash
git clone https://github.com/your-username/AutoControl.git
cd AutoControl
```
3. 创建新分支:
```bash
git checkout -b feature/your-feature-name
```
#### 开发规范
**代码风格**
- 遵循 PEP 8 Python 代码规范
- 使用有意义的变量名和函数名
- 添加必要的注释和文档字符串
**提交信息**
```
<type>(<scope>): <subject>
<body>
<footer>
```
类型(type):
- `feat`: 新功能
- `fix`: Bug 修复
- `docs`: 文档更新
- `style`: 代码格式调整
- `refactor`: 重构
- `test`: 测试相关
- `chore`: 构建/工具链相关
示例:
```
feat(analysis): 添加状态空间分析模块
- 实现状态空间表示转换
- 添加可控性和可观测性判断
- 集成到主界面标签页
Closes #123
```
#### 测试
在提交前确保:
- 代码能正常运行
- 没有破坏现有功能
- 新功能经过测试
#### 提交 Pull Request
1. 推送到您的 Fork
```bash
git push origin feature/your-feature-name
```
2. 在 GitHub 上创建 Pull Request
3. 填写 PR 描述:
- 做了什么改动
- 为什么需要这个改动
- 如何测试
4. 等待代码审查
## 📋 开发任务
### 当前优先级
#### 高优先级
- [ ] 修复已知 Bug
- [ ] 改进性能(大系统分析优化)
- [ ] 移动端适配
#### 中优先级
- [ ] 状态空间分析模块
- [ ] PID 控制器调优工具
- [ ] 系统对比功能
#### 低优先级
- [ ] 导出分析报告
- [ ] 多语言支持
- [ ] 主题切换(暗色模式)
### 适合新手的任务
标记为 `good first issue` 的 Issue 适合新手参与:
- 文档改进
- UI 微调
- 小功能添加
## 🎨 UI/UX 贡献
我们欢迎设计相关的贡献:
- 界面美化
- 交互优化
- 图标设计
- 配色方案
## 📚 文档贡献
文档同样重要:
- 修正错别字
- 改进说明
- 添加示例
- 翻译文档
## 💬 社区
- GitHub Issues: 技术讨论
- [讨论区](https://github.com/your-repo/discussions): 一般交流
## ⚖️ 行为准则
### 我们的承诺
为建设开放友好的环境,我们贡献者和维护者承诺:
- 使用友好和包容的语言
- 尊重不同的观点和经验
- 优雅地接受建设性批评
- 关注对社区最有利的事情
### 不可接受的行为
- 使用性暗示语言或图像
- 挑衅、侮辱性评论,人身攻击
- 公开或私下骚扰
- 未经许可发布他人隐私信息
## 📄 许可证
贡献代码即表示您同意将您的贡献以 MIT 许可证授权。
---
**感谢您的贡献!** 🎉
如有任何问题,请随时联系维护者。