Star48
24
代码
代码
Issues63
Pull Requests2
讨论
Wiki
分析
Star48
24
Aaflyingtodocs: fix 4 MINOR issues from PR #333 review
0e72504a创建于 2 天前历史提交

CLAUDE.md

本文件是 Claude 在 gitcode-cli 仓库中的项目级入口文档。

如果任务涉及代码、文档、流程、评审或发布，请先阅读：

  1. spec/README.md
  2. docs/README.md
  3. README.md

1. 入口职责

CLAUDE.md 的职责是：

  • 为 Claude 提供仓库级入口
  • 指向正式规范、用户文档和后续 skill 分层
  • 约束代理不得绕过项目正式规则

CLAUDE.md 不是项目规则源。

项目正式规则以 spec/README.md 和 spec/ 目录中的规范文档为准。

2. 必读文档

先读：

  1. spec/README.md

再根据任务进入对应规范，不要机械顺序通读全部文档。

常用任务入口：

  • 改命令行为：spec/workflows/development-workflow.md、spec/governance/docs-governance.md、spec/foundations/code-quality-gates.md
  • 改 agent / script 可消费性：spec/foundations/agent-friendly-cli.md、spec/foundations/code-quality-gates.md
  • 改 API / auth / config：spec/foundations/coding-standards.md、spec/foundations/security.md、spec/foundations/testing-guide.md
  • 补测试或做真实命令验证：spec/foundations/testing-guide.md、spec/workflows/test-workflow.md
  • 提交 PR / 做 review：spec/workflows/pr-workflow.md、spec/workflows/review-workflow.md
  • 改构建 / 打包 / 发布：spec/delivery/build-and-package.md、spec/delivery/release-process.md

具体流程任务再进入：

3. 核心执行规则

Claude 在本仓库中必须遵守：

  • 项目命令固定为 gc
  • 项目正式规范以 spec/ 为准
  • 命令行为以 docs/COMMANDS.md 为准
  • 项目阶段说明可参考 issues-plan/PROGRESS.md，但该文档可能滞后，不作为单个 issue / PR 实时状态真相源
  • 流程推进以 spec/workflows/* 定义的状态机为准，不能只把 checklist 当完成标准
  • 状态标签必须随流程推进实时更新（参见 status-label-checklist.md）：
    • Issue: status/triage → status/verified → status/in-progress → status/merged
    • PR: status/draft → status/self-checked → status/ready-for-review → status/approved → status/merged
    • 每个 PR 开发步骤完成后立即更新状态标签，不得在合入后一次性处理
  • 判断"某个 issue / 功能是否已合入主干"时，必须以 merged PR 和 origin/main 为准，不能只依据 issue 状态、issue comment、release 文案或功能分支存在与否
  • 如果 issue 已关闭但没有 merged PR 或 origin/main 不包含对应代码，必须明确判定为"未完成主干合入"
  • 外部项目使用 AI 操作 GitCode 的说明以 docs/AI-GUIDE.md 为准，但该文档不定义本仓库内部开发流程
  • 代码或流程变化后必须同步检查相关文档
  • 实际命令测试只能使用 infra-test/*
  • 不得在 main 直接开发
  • 不得提交构建产物、评估输出或真实凭证
  • 不得在缺少验证记录、自检证据或独立执行主体评审的情况下宣称"已完成"
  • 遇到规范未覆盖的情况，必须先向用户确认，不得自由发挥
  • 发现规范之间有冲突，必须先向用户报告，以用户确认为准
  • MEMORY.md 是会话级记忆摘要，如果与 spec/ 冲突，以 spec/ 为准

4. Claude 入口边界

当前仓库内的 Claude 项目级入口是：

  • CLAUDE.md

历史曾引入 .ai/skills/ 与 .claude/skills/ 作为共享 skill 真相源与客户端适配层，但自 commit a0264be、7287d85 起已停止仓库追踪，改为用户级 ~/.claude/skills/（worktree-safe）。

Claude 应先以 spec/ 和本文件为主要入口。

5. 常用入口