Add comprehensive GitHub Copilot development instructions #1508
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 detailed development guidance for GitHub Copilot coding agents working in the homebridge-camera-ffmpeg repository.What's Included
The instructions cover all essential development workflows that have been thoroughly validated:
Setup and Dependencies
npm ci
(notnpm install
) to maintain version consistencyBuild and Test Workflows
npm run build
(~5 seconds)npm run test
(~1.3 seconds)npm run lint
(~2.4 seconds)Plugin Architecture
src/homebridge-ui/
@homebridge-plugins/homebridge-camera-ffmpeg
)Functional Testing
Common Development Pitfalls
npm install
vsnpm ci
Validation Process
Every command and workflow in these instructions has been thoroughly tested:
The instructions are designed to save agents significant time by providing known-working commands and preventing common setup issues like ESLint configuration conflicts that occur when dependency versions are updated incorrectly.
Fixes #1507.
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:
224.0.0.251
esm.ubuntu.com
/usr/lib/apt/methods/https
(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 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.