Add comprehensive GitHub Copilot instructions for BlockPy Server development #68
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
…y Server Co-authored-by: acbart <897227+acbart@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for BlockPy Server development
Aug 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 PR adds comprehensive development instructions for GitHub Copilot coding agents working with the BlockPy Server repository. The instructions provide detailed setup procedures, build commands, timing expectations, and troubleshooting guidance for this Flask-based educational LTI application.
Key Features
Complete Development Workflow: Step-by-step instructions covering Python virtual environment setup, frontend TypeScript build process, database configuration, and both local development and Docker-based deployment.
Critical Timing Information: All commands include measured execution times and appropriate timeout recommendations:
Network Issue Handling: Documents common PyPI connectivity problems with SSL certificate errors and provides specific workarounds using trusted hosts and increased timeouts.
Comprehensive Validation: Manual testing procedures to verify application functionality after changes, including database connectivity, frontend builds, and complete user workflow validation.
Architecture Overview: Clear explanation of the Flask backend with PostgreSQL, TypeScript frontend with Webpack, Redis task queue, and Docker Compose deployment stack.
The instructions follow an imperative tone ("Run this command", "Set timeout to X minutes") and prioritize commands that have been validated to work. They include extensive troubleshooting sections for common issues like dependency conflicts, database connection problems, and Docker service failures.
This enables GitHub Copilot agents to work effectively with the codebase from a fresh clone, understanding both the development workflow and the expected challenges in the environment.
Fixes #67.
💡 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.