Skip to content

Migrate project to Claude Code as primary AI coding assistant#1161

Merged
hotlong merged 1 commit intomainfrom
claude/migrate-to-claude-code
Apr 16, 2026
Merged

Migrate project to Claude Code as primary AI coding assistant#1161
hotlong merged 1 commit intomainfrom
claude/migrate-to-claude-code

Conversation

@Claude
Copy link
Copy Markdown
Contributor

@Claude Claude AI commented Apr 16, 2026

Establishes Claude Code as the recommended AI coding assistant for ObjectStack development while maintaining backward compatibility with GitHub Copilot and Cursor.

Changes

  • CLAUDE.md: Enhanced as primary instruction file

    • Updated header to clarify it's the primary (not "equivalent") instruction file
    • Added comprehensive "Claude Code Best Practices" section (~50 lines)
      • Effective prompting guidelines specific to Claude Code
      • How to leverage multi-file awareness and deep analysis features
      • Repository-specific workflow tips
      • Example prompts for common tasks (Data Protocol, Testing, Architecture)
    • Reordered AI assistant references to list Claude Code first
  • .github/copilot-instructions.md: Updated for multi-assistant compatibility

    • Acknowledged Claude Code in skills directory comment
  • .github/prompts/README.md: Converted to assistant-agnostic

    • Restructured "For GitHub Copilot" → "For AI Coding Assistants"
    • Listed Claude Code as "Recommended"
    • Maintained Copilot and Cursor compatibility
  • .github/prompts/OVERVIEW.md: Updated Chinese documentation

    • Converted from Copilot-specific to multi-assistant support
    • Listed Claude Code as recommended (推荐)

Example Usage

Developers can now leverage Claude Code-specific features:

"I need to add a new field type 'geolocation' to packages/spec/src/data/field-type.zod.ts.
First, read the existing field types to understand the pattern, then implement following
the Zod-first approach with proper TSDoc comments."

All existing GitHub Copilot workflows remain unchanged.

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 16, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
objectstack-demo Ready Ready Preview, Comment Apr 16, 2026 2:03am
spec Ready Ready Preview, Comment Apr 16, 2026 2:03am

Request Review

@github-actions github-actions bot added documentation Improvements or additions to documentation size/s labels Apr 16, 2026
@Claude Claude AI requested a review from hotlong April 16, 2026 02:04
@hotlong hotlong marked this pull request as ready for review April 16, 2026 02:05
Copilot AI review requested due to automatic review settings April 16, 2026 02:05
@hotlong hotlong merged commit fa810d5 into main Apr 16, 2026
14 checks passed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates repository AI-assistant documentation to position Claude Code as the recommended assistant while keeping GitHub Copilot and Cursor compatibility through shared instructions and prompt documentation.

Changes:

  • Promote CLAUDE.md as the primary instruction entrypoint and add a Claude Code best-practices section.
  • Make .github/prompts/* documentation assistant-agnostic and mark Claude Code as recommended.
  • Update Copilot instructions and prompt docs to reference Claude Code alongside Copilot/Cursor.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.

File Description
CLAUDE.md Reframes as primary Claude Code instructions and adds a “Claude Code Best Practices” section.
.github/prompts/README.md Renames Copilot-specific usage section to multi-assistant usage and adds assistant list.
.github/prompts/OVERVIEW.md Updates Chinese prompt documentation from Copilot-specific to multi-assistant support.
.github/copilot-instructions.md Minor wording update to include Claude Code in the skills/ directory comment.

Comment on lines +117 to 126
### AI 编码助手集成

这些提示词会被 GitHub Copilot 自动加载:
这些提示词兼容多个 AI 编码助手:

- **Claude Code**(推荐):从代码库上下文自动加载
- **GitHub Copilot**:在代码库中工作时自动加载
- **Cursor**:可引用这些提示词获取上下文感知帮助

提示词会根据以下内容自动加载:

Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

这里写“提示词会…自动加载/从代码库上下文自动加载”可能会让人误以为 .github/prompts/*.prompt.md 会被助手默认注入上下文。建议改成更精确的描述(例如:这些提示词文件可被选择/引用/调用以提供上下文),并说明不同助手的使用方式差异。

Copilot uses AI. Check for mistakes.
Comment on lines 90 to +93
│ ├── app-crm/ # Advanced: full CRM with relations
│ └── plugin-bi/ # Plugin example: BI dashboard
├── skills/ # 🤖 AI skill definitions (for Copilot/Cursor)
├── skills/ # 🤖 AI skill definitions (for Claude Code, Copilot, Cursor)
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This monorepo structure block uses objectstack-ai/spec/ as the root, while CLAUDE.md uses objectstack-ai/framework/, and the actual repository root is neither. Since this section is meant to orient contributors, please align the root path across both instruction files (or switch to a root-agnostic label) to avoid confusion.

Copilot uses AI. Check for mistakes.
Comment thread CLAUDE.md
> This file is the **Claude Code** equivalent of `.github/copilot-instructions.md` (GitHub Copilot).
> This file is the **Claude Code** primary instruction file for ObjectStack development.
> A parallel `.github/copilot-instructions.md` exists for GitHub Copilot compatibility.
> Keep both files in sync when updating project-wide AI instructions.
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The header still says “Keep both files in sync”, but this file now intentionally contains Claude Code–specific content (e.g., the “Claude Code Best Practices” section) that does not exist in .github/copilot-instructions.md. Consider clarifying what must stay synchronized (shared directives/structure) vs what is allowed to diverge (assistant-specific guidance), otherwise the “synced” note becomes misleading.

Suggested change
> Keep both files in sync when updating project-wide AI instructions.
> Keep shared project-wide directives, structure, and core architectural guidance synchronized between both files.
> Assistant-specific guidance may differ where needed for Claude Code or GitHub Copilot behavior.

Copilot uses AI. Check for mistakes.
Comment thread CLAUDE.md
Comment on lines 89 to 93
│ └── server/ # 🚀 Production server (multi-app orchestration)
├── examples/ # 📚 Reference implementations
├── skills/ # 🤖 AI skill definitions (for Copilot/Cursor/Claude)
├── skills/ # 🤖 AI skill definitions (for Claude Code, Copilot, Cursor)
└── content/docs/ # 📝 Documentation content
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The monorepo structure diagram appears inconsistent with the rest of the repo and with .github/copilot-instructions.md (this file shows objectstack-ai/framework/, Copilot instructions show objectstack-ai/spec/, while the repository root here is neither). This can confuse readers; please align both diagrams to the actual repo layout or use a neutral root like objectstack-ai/.

Copilot uses AI. Check for mistakes.
Comment thread .github/prompts/README.md
Comment on lines +149 to +151
- **Claude Code** (Recommended): Automatically loaded from the repository context
- **GitHub Copilot**: Automatically loaded when working in the repository
- **Cursor**: Can reference these prompts for context-aware assistance
Copy link

Copilot AI Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text claims these prompt files are “Automatically loaded” by Claude Code/Copilot. Unless there is a specific integration that loads .github/prompts/*.prompt.md implicitly, this wording is likely to mislead—Claude Code is documented to auto-load CLAUDE.md, but prompt files typically need to be referenced/selected. Suggest rephrasing to describe the actual usage mechanism (e.g., “available as prompt files you can invoke/reference”).

Suggested change
- **Claude Code** (Recommended): Automatically loaded from the repository context
- **GitHub Copilot**: Automatically loaded when working in the repository
- **Cursor**: Can reference these prompts for context-aware assistance
- **Claude Code** (Recommended): Available as repository prompt files you can reference alongside the repo context
- **GitHub Copilot**: Available as prompt files you can open, reference, or adapt while working in the repository
- **Cursor**: Can reference these prompt files for context-aware assistance

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants