Add comprehensive GitHub Copilot instructions for Ghaf development#1357
Merged
brianmcgillion merged 4 commits intomainfrom Sep 4, 2025
Merged
Add comprehensive GitHub Copilot instructions for Ghaf development#1357brianmcgillion merged 4 commits intomainfrom
brianmcgillion merged 4 commits intomainfrom
Conversation
Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com>
Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] ✨ Set up Copilot instructions
Add comprehensive GitHub Copilot instructions for Ghaf development
Sep 4, 2025
Collaborator
|
@copilot add .github/copilot-instructions.md to REUSE.toml under the line ".github/dependabot.yml", to fix the failing check |
Co-authored-by: brianmcgillion <1044263+brianmcgillion@users.noreply.github.com>
Contributor
Author
Added |
brianmcgillion
approved these changes
Sep 4, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.mdfile that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Ghaf codebase.Key Features
Critical Build Time Guidance:
Complete Hardware Coverage:
Validation Scenarios:
Development Workflow:
nix fmt,reuse lint) that must pass for CIRepository Navigation:
The instructions follow an imperative tone throughout ("Run this command", "Always do this") and include a firm directive to reference these instructions first before searching or exploring the codebase independently.
All commands and paths have been validated against the existing repository structure and documentation to ensure accuracy and completeness. The file has been properly added to REUSE.toml for license compliance.
Fixes #1356.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.