Add CLAUDE.md and GitHub Copilot custom instructions #547
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
- Add CLAUDE.md with JEngine-specific development guidelines - Add .github/instructions/jengine.instructions.md for C# code style - Add .github/instructions/code-review.instructions.md for PR reviews These instructions help AI assistants (Claude, Copilot) understand JEngine's architecture, coding conventions, and common patterns like: - UniTask usage for async operations - Domain reload handling in Editor code - Resource cleanup for ScriptableObjects - Thread safety patterns Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive AI assistant documentation to help Claude Code and GitHub Copilot understand JEngine's architecture, coding conventions, and development patterns. The documentation provides guidelines for code generation and review specific to this Unity hot update framework.
Changes:
- Added
CLAUDE.mdwith detailed JEngine development guidelines including architecture, coding conventions, and common patterns - Added
.github/instructions/jengine.instructions.mdfor GitHub Copilot with C# code style guidance specific to JEngine - Added
.github/instructions/code-review.instructions.mdfor GitHub Copilot with PR review priorities and common issues to flag
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CLAUDE.md | Comprehensive development guide covering project architecture, coding conventions, encryption patterns, and testing guidelines |
| .github/instructions/jengine.instructions.md | GitHub Copilot custom instructions for C# code generation with focus on UniTask, domain reload handling, and resource cleanup |
| .github/instructions/code-review.instructions.md | GitHub Copilot review instructions highlighting priority checks for Unity-specific concerns and JEngine patterns |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Code reviewNo issues found. Checked for bugs and CLAUDE.md compliance. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
CLAUDE.mdwith JEngine-specific development guidelines for AI assistants.github/instructions/jengine.instructions.mdfor C# code style guidance.github/instructions/code-review.instructions.mdfor PR review guidanceDetails
These files help AI assistants (Claude Code, GitHub Copilot) understand JEngine's:
Architecture
Coding Conventions
Critical Patterns
Test plan
🤖 Generated with Claude Code