Skip to content

在 CONTRIBUTING.md 中补充 AI 协作约定 #31

@keting

Description

@keting

Problem

CONTRIBUTING.md 当前没有针对"使用 AI 工具协作"的明确约定。HALF 的主题就是 agent 协作平台,外部贡献者越来越可能用 Claude Code、Copilot、Cursor 等工具辅助开发,缺少约定容易出现"AI 直接提交未经人工 review 的 PR"等问题。

Proposed Change

CONTRIBUTING.md 新增一节,标题中性(如 ## Using AI Assistants),覆盖:

  • 跑现有 test / build 后再提 PR
  • 敏感目录提醒(schema、auth 相关,希望 AI 改动前先开 issue 讨论)
  • PR 描述里建议(不强制)标注是否使用了 AI 辅助
  • 不接受未经人工 review 直接由 AI 提交的 PR

本质上是 contributor policy(贡献流程规范),不是普通文档补充。

Why It Matters

明确约定能预防外部 PR 出现常见的 AI 协作陷阱(粗放修改、未人工把关、改动越界),同时对熟悉 agent 协作的贡献者展示 HALF 项目本身在这方面的成熟度。

Additional Context

  • 不做:
    • 新建 CLAUDE.md / AGENTS.md(绑定特定 AI 工具生态,且与项目已有的中性立场冲突)
    • 不做 skill(Claude 专属、外部贡献者不可见)
  • 演进: 如果未来这一节内容长起来,可以拆出 docs/contributing-with-ai.md,CONTRIBUTING.md 保留链接
  • 优先级: P3,无紧迫性

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentation, guides, and contributor docsstatus:readyTriaged and ready to pick uptype:maintenanceRefactor, tooling, chores, or non-user-facing upkeep

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions