-
Notifications
You must be signed in to change notification settings - Fork 1
Add comprehensive GitHub Copilot instructions with Docker Compose workflow #249
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: dannystaple <426859+dannystaple@users.noreply.github.com>
The updated branch should fix the docker compose 7 minute issue (staging shouldn't automatically start with docker compose up). The critical known issues should be fixed, but docker compose is what I have used for some time and should be the go to method. |
🦙 MegaLinter status: ❌ ERROR
See detailed report in MegaLinter reports |
@copilot can you address the comments here for me please? |
…lopment method Co-authored-by: dannystaple <426859+dannystaple@users.noreply.github.com>
Updated the instructions to reflect Docker Compose as the intended primary development method. Removed all warnings about Docker being broken and provided proper Docker Compose commands with timing expectations. Native npm commands are now documented as alternatives (c75435d).
All comments have been addressed - updated site description, corrected Docker Compose as primary development method, and removed outdated Docker warnings (c75435d). |
This PR adds a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot with detailed instructions for working effectively in the orionrobots.github.io codebase using Docker Compose as the primary development method.What's Included
The instructions cover the complete Docker-first development workflow with validated commands and timing expectations:
Docker Compose Workflow
docker compose up
for full development server (~4-5 minutes initial build)docker compose run dist
(~30 seconds) anddocker compose run build
(~3 minutes)docker compose run test
for containerized BDD testsSite Configuration
Comprehensive Coverage
Development Safety
All commands include proper timeout recommendations with "NEVER CANCEL" warnings for long-running builds. Every timing estimate is based on actual Docker Compose performance testing.
The instructions follow the imperative tone requirement and provide exhaustive guidance to minimize incorrect commands while establishing Docker Compose as the intended primary development workflow.
Fixes #248.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.