-
Notifications
You must be signed in to change notification settings - Fork 6
Add comprehensive Copilot instructions for repository onboarding #12
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
Add comprehensive Copilot instructions for repository onboarding #12
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: mikebarkmin <2592379+mikebarkmin@users.noreply.github.com>
|
@copilot can you configure action steps to download jogl beforehand. So that the you do not fail? |
|
@copilot I added jogamp.org to the allowed urls. |
Co-authored-by: mikebarkmin <2592379+mikebarkmin@users.noreply.github.com>
Perfect! I've verified that all build commands now work correctly with jogamp.org in the allowlist. Updated the Copilot instructions to reflect the working state: ✅ Removed the outdated dependency warnings and updated troubleshooting steps. The instructions now accurately represent the current working build process. (commit 135ccfa) |
…a271-3bc63c55e9ed Add comprehensive Copilot instructions for repository onboarding
This PR adds detailed Copilot instructions at
.github/copilot-instructions.mdto help coding agents work efficiently with the Scratch for Java repository from their first interaction.What this solves
Coding agents previously had to spend significant time exploring the repository structure, discovering build processes, and understanding the codebase architecture. This often led to:
What's included
The instructions provide comprehensive guidance covering:
Repository Architecture: Complete overview of the Scratch-to-Java transition library, including the core Window/Stage/Sprite hierarchy and all extension modules (animation, camera, color, math, pen, recorder, etc.).
Build System: Detailed Maven configuration with three profiles (default, central, all), with all build commands verified and working correctly. The jogamp repository dependency issue has been resolved through allowlist configuration.
Documentation System: Full explanation of the dual-language (English/German) Hyperbook-based documentation system, including build commands and the custom
s4jscript for validating documentation coverage.Development Workflow: GitHub Actions workflows for automated versioning with changesets, Maven Central publishing with GPG signing, and GitHub Pages deployment for Javadocs.
Project Layout: Detailed mapping of source structure with 56 main classes, 146 reference examples, 59 demo projects, and starter templates for VS Code and BlueJ.
Common Patterns: Code examples showing typical Sprite implementations, Stage event handlers, and Window setup following the library's established patterns.
Validation performed
npx hyperbook,./s4jscript)These instructions will significantly reduce the time coding agents spend on initial repository exploration and provide accurate, up-to-date build guidance.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.