-
-
Notifications
You must be signed in to change notification settings - Fork 2
Add GitHub Copilot instructions for repository context #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: jonobr1 <220033+jonobr1@users.noreply.github.com>
Co-authored-by: jonobr1 <220033+jonobr1@users.noreply.github.com>
Co-authored-by: jonobr1 <220033+jonobr1@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds GitHub Copilot workspace instructions to provide AI-assisted development with project-specific context about react-two.js architecture, coding standards, and best practices.
- Creates
.github/copilot-instructions.mdwith comprehensive project documentation - Documents TypeScript standards, React patterns, and Two.js integration requirements
- Establishes canvas boundary rules and animation performance guidelines
|
|
||
| ### Peer Dependencies | ||
| - Ensure React 18.3+ is installed | ||
| - Two.js must be from @jonobr1/two.js#dev branch |
Copilot
AI
Dec 5, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The instruction to use the 'dev' branch may become outdated. Consider adding context about when/why the dev branch is required, or if this is a temporary requirement until features are merged to main.
| - Two.js must be from @jonobr1/two.js#dev branch | |
| - Two.js must be installed from @jonobr1/two.js#dev branch (required for features/fixes not yet available in main, such as [list key features or fixes if known]). This is a temporary requirement until these changes are merged into main—check the Two.js repository for updates and switch to main when possible. |
Configures GitHub Copilot workspace instructions to provide project-specific context for better code suggestions.
Changes
.github/copilot-instructions.mdwith:useTwo,useFramehooks)Key Patterns Documented
Component Structure:
Canvas Boundaries:
Animation Pattern:
Based on existing
CLAUDE.mddocumentation, formatted for GitHub Copilot's workspace instruction format.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
gh.io/usr/bin/curl curl -sL REDACTED(dns block)/usr/bin/wget wget -qO- REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.