Excel MCP Server

# 贡献指南 (Contributing Guide) 感谢你对Excel MCP Server项目的关注！我们欢迎所有形式的贡献。 ## 🚀 如何贡献 ### 报告Bug 1. 查看 [现有Issues](https://github.com/YOUR_USERNAME/excel-mcp/issues) 确保该bug未被报告 2. 创建新Issue，详细描述： - Bug的具体表现 - 重现步骤 - 期望的行为 - 实际的行为 - 环境信息（Python版本、操作系统等） ### 提出新功能 1. 创建Feature Request Issue 2. 详细描述功能需求和使用场景 3. 等待社区讨论和反馈 ### 提交代码 1. Fork该仓库 2. 创建功能分支：`git checkout -b feature/amazing-feature` 3. 进行更改并确保代码质量 4. 提交更改：`git commit -m 'Add amazing feature'` 5. 推送到分支：`git push origin feature/amazing-feature` 6. 创建Pull Request ## 📝 开发规范 ### 代码风格 - 遵循PEP 8 Python代码规范 - 使用有意义的变量和函数名 - 添加适当的注释和文档字符串 - 保持代码简洁和可读性 ### 提交信息规范 使用以下格式的提交信息： ``` <type>: <description> [optional body] ``` 类型包括： - `feat`: 新功能 - `fix`: Bug修复 - `docs`: 文档更新 - `style`: 代码格式化 - `refactor`: 代码重构 - `test`: 添加测试 - `chore`: 其他更改 ### 测试要求 - 为新功能添加相应的测试用例 - 确保所有现有测试通过 - 测试覆盖率应保持在80%以上 ## 🏗️ 开发环境设置 1. **克隆仓库** ```bash git clone https://github.com/YOUR_USERNAME/excel-mcp.git cd excel-mcp ``` 2. **安装依赖** ```bash pip install -r requirements.txt ``` 3. **运行测试** ```bash python tests/test_excel_mcp.py python test_quick.py ``` 4. **启动开发服务器** ```bash python server.py ``` ## 🧪 测试指南 ### 运行测试 ```bash # 运行所有测试 python -m pytest tests/ # 运行特定测试 python tests/test_excel_mcp.py # 快速功能测试 python test_quick.py ``` ### 添加新测试 1. 在`tests/`目录下创建测试文件 2. 使用描述性的测试函数名 3. 包含边界情况和错误处理测试 4. 确保测试的独立性 ## 📚 文档更新 - 更新相关的README.md文件 - 更新API文档 - 添加使用示例 - 更新配置说明 ## 🤝 行为准则 - 保持友善和尊重的态度 - 欢迎新贡献者 - 建设性地提供反馈 - 专注于代码和功能改进 ## 🔍 代码审查 ### 提交Pull Request前的自检清单 - [ ] 代码遵循项目规范 - [ ] 添加了必要的测试 - [ ] 所有测试通过 - [ ] 更新了相关文档 - [ ] 提交信息清晰明确 ### 审查流程 1. 自动化测试检查 2. 代码质量检查 3. 功能测试 4. 文档审查 5. 最终批准和合并 ## 📞 获取帮助 如果你在贡献过程中遇到任何问题： 1. 查看 [文档](docs/) 2. 搜索 [现有Issues](https://github.com/YOUR_USERNAME/excel-mcp/issues) 3. 在相关Issue中提问 4. 创建新的Discussion ## 🎉 认可贡献者 我们会在以下地方认可所有贡献者： - README.md的贡献者部分 - 发布说明 - 项目文档 再次感谢你的贡献！