SuperAPI AI 工具集

contribution-guidelines

编程与开发

查看项目

更新于 10-16 06:57

技能介绍

用途

该技能旨在帮助开发者遵循规范的开源贡献流程,包括 PR 工作流、代码审查标准与提交约定。适用于以下场景:提交拉取请求、进行代码审查、参与开源贡献、报告缺陷或请求新功能。

主要能力

技能围绕开源协作流程提供结构化指导,覆盖从准备仓库到提交 PR 的完整环节,并给出代码审查清单与提交类型规范。

使用方式

拉取请求流程

  1. Fork 与克隆
git clone https://github.com/YOUR-USERNAME/European-Parliament-MCP-Server.git
cd European-Parliament-MCP-Server
git remote add upstream https://github.com/Hack23/European-Parliament-MCP-Server.git
  1. 创建功能分支
git checkout -b feature/new-mcp-tool
  1. 进行修改
npm ci                  # Install dependencies
npm run lint            # Check code style
npm test                # Run tests
npm run build           # Verify build
  1. 使用 Conventional Commits 提交
git commit -m "feat: add search_votes MCP tool"
git commit -m "fix: handle API timeout in MEP lookup"
git commit -m "docs: update SECURITY_ARCHITECTURE.md"
git commit -m "test: add integration tests for committee API"
  1. 提交 PR
git push origin feature/new-mcp-tool
# Create PR via GitHub UI

代码审查清单

面向贡献者:

  • 所有测试通过(npm test)
  • Lint 通过(npm run lint)
  • TypeScript 类型检查通过(npx tsc --noEmit)
  • 代码遵循项目约定
  • 文档已更新
  • 未提交任何密钥
  • 测试覆盖率保持(80%+)

面向审查者:

  • 代码可维护且类型良好
  • 使用 Zod schema 进行输入验证
  • 错误处理遵循既定模式
  • 已考虑安全影响
  • 已验证 ISMS 政策合规性
  • 性能影响可接受

提交类型

类型 描述
feat 新功能
fix 缺陷修复
docs 仅文档
style 代码风格(格式化)
refactor 代码重构
test 添加/更新测试
chore 维护任务
security 安全修复

ISMS 政策参考

核心政策:

  • 开源政策 — 主要政策:贡献标准、许可、DCO、再分发、供应链
  • 安全开发政策 — 代码审查要求、CI 门禁、测试覆盖率
  • 信息安全政策 — 透明度、社区信任
  • 变更管理 — PR 工作流、审批、可逆性

支持性政策(适用时引用):

  • 隐私政策 — 贡献者 PII(git log 中的邮箱)处理
  • 访问控制政策 — 分支保护、CODEOWNERS
  • AI 政策 — 当贡献由 AI 辅助时进行披露
  • 漏洞管理 — 安全相关贡献的负责任披露

适用场景

适用于参与 European-Parliament-MCP-Server 项目或其他采用类似流程的开源项目,帮助贡献者与审查者按统一标准协作。

限制

该技能内容基于所提供资料,未提供关于具体项目环境、依赖版本、CI 配置细节或平台差异的进一步说明。