Add comprehensive CLAUDE.md for AI assistants #721
Closed
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file provides AI assistants with essential context about: - Repository purpose (documentation/issue tracking, not source code) - GitHub Copilot CLI architecture and key features - Development workflows and conventions - How to work with issues and documentation - Quick reference for common scenarios The guide emphasizes that this is a public docs repository, with detailed information extracted from the comprehensive changelog and README to help AI assistants provide accurate, helpful guidance.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a comprehensive guide for AI assistants (CLAUDE.md) to help them understand the GitHub Copilot CLI repository structure, purpose, and key information.
Purpose: Provide AI assistants with essential context about the repository's role as a public documentation and issue tracking repo (not source code), along with detailed information about GitHub Copilot CLI's architecture, features, and development workflows.
Key Changes:
- New comprehensive CLAUDE.md file with 350 lines covering repository structure, architecture, tools, configuration, and conventions
- Detailed sections on the agentic architecture, MCP servers, permission system, and slash commands
- Guidelines for AI assistants when working with issues, documentation, and user questions
- Quick reference materials including version history highlights and decision trees
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This file provides AI assistants with essential context about:
The guide emphasizes that this is a public docs repository, with detailed information extracted from the comprehensive changelog and README to help AI assistants provide accurate, helpful guidance.