Add comprehensive GitHub Copilot instructions and linting requirements for python-matter-server development #1231
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 python-matter-server codebase, along with mandatory linting and code quality requirements.What's Included
The instructions provide exhaustive guidance covering:
Development Setup & Build Process:
scripts/setup.sh
(3-5 minute typical duration)Validation Scenarios:
Repository Navigation:
matter_server/
,dashboard/
,scripts/
,tests/
)Linting and Code Quality Requirements:
Troubleshooting & Common Issues:
Validation Performed
All documented commands were tested and validated:
Design Philosophy
The instructions follow an imperative tone ("Run this command", "Do not do this") and prioritize:
This ensures GitHub Copilot agents can work effectively in the codebase with minimal trial-and-error, following the exact same patterns a human developer would use after acquiring expertise with the project, while maintaining the project's code quality standards.
Fixes #1230.
💡 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.