102 lines
2.3 KiB
Markdown
102 lines
2.3 KiB
Markdown
# 贡献指南
|
|
|
|
欢迎参与胡汉三千年项目！本项目致力于通过开源工具传播中华文明的世界史意义。
|
|
|
|
## 🎯 贡献方式
|
|
|
|
### 1. 代码贡献
|
|
- **音韵分析工具**：改进音韵考古学算法
|
|
- **可视化系统**：开发交互式理论展示界面
|
|
- **数据处理**：优化文明传播模型的数据处理
|
|
|
|
### 2. 理论研究
|
|
- **理论验证**：提供实证数据支持理论框架
|
|
- **跨学科整合**：连接语言学、历史学、考古学等领域
|
|
- **方法论创新**：改进研究方法和分析工具
|
|
|
|
### 3. 文档完善
|
|
- **使用教程**：编写工具使用指南
|
|
- **理论解释**：简化复杂理论的解释
|
|
- **示例代码**：提供实用的代码示例
|
|
|
|
## 🚀 快速开始
|
|
|
|
### 开发环境设置
|
|
```bash
|
|
# 克隆项目
|
|
git clone https://github.com/ben/huhan3000.git
|
|
cd huhan3000
|
|
|
|
# 安装依赖
|
|
pip install -r requirements.txt
|
|
|
|
# 运行测试
|
|
pytest tests/
|
|
```
|
|
|
|
### 项目结构
|
|
```
|
|
huhan3000/
|
|
├── core-theory/ # 核心理论
|
|
├── tools/ # 开源工具
|
|
├── research/ # 学术研究
|
|
├── docs/ # 项目文档
|
|
├── examples/ # 使用示例
|
|
└── tests/ # 测试用例
|
|
```
|
|
|
|
## 📝 提交规范
|
|
|
|
### 分支命名
|
|
- `feature/音韵分析优化` - 新功能开发
|
|
- `bugfix/符号查询修复` - 问题修复
|
|
- `docs/理论指南更新` - 文档更新
|
|
|
|
### 提交信息格式
|
|
```
|
|
类型(范围): 简短描述
|
|
|
|
详细描述（可选）
|
|
|
|
关联Issue: #123
|
|
```
|
|
|
|
**类型说明：**
|
|
- `feat`: 新功能
|
|
- `fix`: 问题修复
|
|
- `docs`: 文档更新
|
|
- `test`: 测试相关
|
|
- `refactor`: 代码重构
|
|
|
|
## 🔧 开发指南
|
|
|
|
### 代码规范
|
|
- 遵循PEP 8编码规范
|
|
- 使用类型注解
|
|
- 编写单元测试
|
|
- 保持代码可读性
|
|
|
|
### 测试要求
|
|
- 新功能必须包含测试用例
|
|
- 测试覆盖率不低于80%
|
|
- 集成测试确保功能完整性
|
|
|
|
## 🤝 社区交流
|
|
|
|
### 讨论渠道
|
|
- GitHub Issues: 功能讨论和问题报告
|
|
- GitHub Discussions: 理论探讨和学术交流
|
|
- 邮件列表: 学术合作和深度讨论
|
|
|
|
### 行为准则
|
|
- 尊重不同学术观点
|
|
- 建设性批评和讨论
|
|
- 包容多元文化视角
|
|
|
|
## 🎁 致谢
|
|
|
|
感谢所有为项目做出贡献的开发者、学者和爱好者！
|
|
|
|
---
|
|
|
|
**让我们一起通过开源工具传播中华文明的智慧！** |