我们欢迎对 MetaMCP 的贡献!这份综合指南将帮助您开始为项目做出贡献,无论是修复错误、添加功能还是改进文档。

开始使用

前置要求

在贡献之前,请确保您具备:
  • Node.js 18+pnpm 已安装
  • Docker 用于运行 PostgreSQL 和测试
  • Git 用于版本控制
  • 对 TypeScript、React 和 MCP 协议的基本了解

开发环境设置

开发工作流程

创建功能分支(命名不是必需的)

git checkout -b feature/your-feature-name

进行更改

在进行更改时请遵循以下指南:

代码质量标准

  • 遵循 TypeScript 最佳实践
  • 使用 ESLint 和 Prettier 保持一致的格式
  • 编写描述性的提交信息
  • 为复杂函数添加 JSDoc 注释
  • 确保整个代码库的类型安全
  • 手动测试您的更改

测试您的更改

贡献类型

错误修复

功能开发

文档

Pull Request 流程

提交之前

提交前检查清单

  • 代码遵循项目标准
  • 尽可能修复代码检查问题(在快速开发时相对宽容) (pnpm lint)
  • 没有 TypeScript 错误
  • 如需要,文档已更新
  • 手动测试了更改
  • 如需要,包含数据库迁移
  • 提交中没有敏感信息

专业贡献

OIDC 提供商设置

MetaMCP 支持 OpenID Connect 用于企业 SSO。在处理 OIDC 功能时:

数据库更改

在进行数据库架构更改时:

前端开发

社区准则

行为准则

我们致力于提供一个欢迎和包容的环境:

社区标准

  • 在所有互动中保持尊重和包容
  • 提供建设性反馈并乐于接受反馈
  • 专注于协作并帮助彼此成功
  • 尊重不同的观点和经验水平
  • 遵循项目指南并保持代码质量

沟通

获得帮助

资源

认可

我们感谢对 MetaMCP 的所有贡献!贡献者通过以下方式获得认可:
  • 仓库上的GitHub 贡献者列表
  • 发布说明中提及重要贡献
感谢您帮助让 MetaMCP 对每个人都更好!🚀

下一步