Copilot support #162
Open
Copilot support #162
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
- Create comprehensive .github/copilot-instructions.md covering: - Project overview and React Facet core concepts - Repository structure and import patterns - All hooks, components, and APIs with usage examples - Common patterns, anti-patterns, and best practices - Testing patterns and quick reference guide - Maintenance guidelines to prevent documentation drift - Add automated validation script (scripts/check-copilot-instructions-sync.sh): - Validates hooks mentioned in docs exist in code - Checks all code hooks are documented - Verifies components, packages, and import paths - Comprehensive inline documentation - Add CI workflow (.github/workflows/validate-copilot-instructions.yml): - Runs on all PRs and pushes to main - Prevents documentation drift before merge - Ensures instructions stay current with codebase This enables GitHub Copilot to provide context-aware code suggestions specific to React Facet patterns and conventions. Add initial copilot-instructions.md doc Instruction updates. Add info on NO_VALUE behaviour in memo/map/setters Update instructions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR introduces Copilot custom instructions and fills in missing public documentation for key components.
🧩 Copilot Custom Instructions
Added comprehensive Copilot instructions to improve AI-assisted workflows — such as documentation writing, API consumption, testing, and onboarding.
Instructions are split into two files:
copilot-instructions.md– full internal instructions used by VS Code.copilot-instructions-public-api.md– a slimmed-down version focused on the public API (for use in Copilot Spaces).Added validation scripts to ensure instructions stay up to date:
/scripts/check-copilot-instructions-sync.sh/scripts/check-public-api-instructions-sync.shIntroduced two Copilot prompts for maintenance:
/fix-instructions– runs desync checks, updates instructions from existing docs, and flags missing documentation./create-documentation– generates new public documentation from referenced source files in collaboration with the user.📘 Public Documentation Additions
Unwrapcomponent — usage, performance, best practices, and comparison withMount.Timescomponent — usage guidance and performance notes.