MCP Reminder Service

# 贡献指南 感谢您对 MCP Reminder 项目的关注！我们欢迎各种形式的贡献。 ## 如何贡献 ### 报告问题 如果您发现了 bug 或有功能建议，请通过以下方式报告： 1. 检查 [Issues](https://github.com/example/mcp-reminder/issues) 中是否已有相关问题 2. 如果没有，请创建新的 Issue，包含： - 详细的问题描述 - 复现步骤 - 期望的行为 - 实际的行为 - 环境信息（Python 版本、操作系统等） ### 提交代码 1. Fork 本仓库 2. 创建特性分支：`git checkout -b feature/amazing-feature` 3. 提交更改：`git commit -m 'Add some amazing feature'` 4. 推送分支：`git push origin feature/amazing-feature` 5. 创建 Pull Request ### 开发环境设置 1. 克隆仓库： ```bash git clone https://github.com/example/mcp-reminder.git cd mcp-reminder ``` 2. 创建虚拟环境： ```bash python -m venv venv source venv/bin/activate # Linux/Mac # 或 venv\Scripts\activate # Windows ``` 3. 安装开发依赖： ```bash make install-dev ``` 4. 运行测试： ```bash make test ``` ### 代码规范 我们使用以下工具来保持代码质量： - **Black**: 代码格式化 - **isort**: 导入排序 - **flake8**: 代码检查 - **mypy**: 类型检查 - **pytest**: 测试框架 在提交代码前，请运行： ```bash make check ``` 这将运行所有代码质量检查。 ### 提交信息规范 请使用清晰的提交信息，格式如下： ``` 类型: 简短描述 详细描述（可选） 相关 Issue: #123 ``` 类型包括： - `feat`: 新功能 - `fix`: 修复 bug - `docs`: 文档更新 - `style`: 代码格式调整 - `refactor`: 代码重构 - `test`: 测试相关 - `chore`: 构建过程或辅助工具的变动 ### 测试 请确保： 1. 新功能有对应的测试 2. 所有测试都能通过 3. 测试覆盖率不低于 80% 运行测试： ```bash make test-cov ``` ### 文档 如果您添加了新功能，请更新相关文档： 1. README.md 2. 代码注释 3. 类型注解 ## 行为准则 请遵循我们的行为准则： - 使用友好和包容的语言 - 尊重不同的观点和经验 - 优雅地接受建设性批评 - 关注对社区最有利的事情 - 对其他社区成员表示同理心 ## 许可证 通过贡献代码，您同意您的贡献将在 MIT 许可证下发布。 ## 联系方式 如果您有任何问题，请通过以下方式联系： - 创建 Issue - 发送邮件到 mcp-reminder@example.com 感谢您的贡献！🎉