Add comprehensive GitHub Copilot instructions for lambda-api development #294
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 a comprehensive
.github/copilot-instructions.md
file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the lambda-api codebase.What's Included
The instructions cover all essential aspects of lambda-api development:
Build and Test Workflow
npm ci
(35 seconds)npm test
- Full test suite (12 seconds, 478 tests)npm run test:unit
- Unit tests only (6 seconds)npm run test:types
- TypeScript validation (4 seconds)npm run test-ci
replicating GitHub Actions workflowValidation Guidelines
The instructions emphasize manual validation with specific test scenarios:
/users/:id
)api.routes(true)
Project Context
Practical Examples
Working code examples demonstrate:
Validation Process
All commands and examples were thoroughly tested:
The instructions enable coding agents to work efficiently without extensive exploration, reducing development time and preventing common mistakes.
Fixes #293.
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:
coveralls.io
node ./node_modules/coveralls/bin/coveralls.js
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.