Add comprehensive GitHub Copilot instructions with validated commands and working tests #5
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 creates comprehensive GitHub Copilot instructions for the FastAPI repository to help developers work effectively with the codebase. The instructions include validated commands, timing expectations, and complete development workflows.
Key Features Added
📋 Comprehensive Copilot Instructions (
.github/copilot-instructions.md
)✅ Working Test Suite
app/tests/test_items.py
🔧 Critical Bug Fixes
database
→core.database
imports in routers{model}_id
toid
DOCKER_BUILDKIT=0
requirement to avoid SSL certificate errorsalembic.ini
/items
prefix causing incorrect routesdocker compose
instead ofdocker-compose
Validated Commands & Timings
Local Development (Recommended)
pip3 install -r requirements.txt
- 30 secondspython3 -m pytest -vvs
- <1 second (4 tests pass)python3 -m black .
- <1 seconduvicorn main:app --reload
- instant startupDocker Development (Production-like)
DOCKER_BUILDKIT=0 make build
- 25 secondsDOCKER_BUILDKIT=0 make test
- 2 secondsDOCKER_BUILDKIT=0 make lint
- <1 secondDOCKER_BUILDKIT=0 make up
- starts with auto-reloadAPI Functionality Validated
The application now has fully working CRUD operations:
The instructions provide exhaustive guidance for any developer working on this FastAPI codebase, ensuring they can build, test, and develop effectively from a fresh clone.
Fixes #4.
💡 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.