Skip to content

Add comprehensive GitHub Copilot instructions for Ghaf development#1357

Merged
brianmcgillion merged 4 commits intomainfrom
copilot/fix-1356
Sep 4, 2025
Merged

Add comprehensive GitHub Copilot instructions for Ghaf development#1357
brianmcgillion merged 4 commits intomainfrom
copilot/fix-1356

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Sep 4, 2025

This PR adds a comprehensive .github/copilot-instructions.md file that provides GitHub Copilot coding agents with detailed instructions for working effectively in the Ghaf codebase.

Key Features

Critical Build Time Guidance:

  • Explicit "NEVER CANCEL" warnings for all major build operations
  • Specific timeout recommendations (60+ to 300+ minutes) aligned with CI configuration
  • Build time estimates for all hardware targets based on documented workflows

Complete Hardware Coverage:

  • x86_64 targets (VM, generic, Lenovo X1, NVIDIA Jetson cross-builds)
  • ARM64 targets (NVIDIA Jetson AGX/NX, i.MX 8MP-EVK)
  • RISC-V targets (Microchip Icicle Kit)
  • Installer image builds with specific requirements

Validation Scenarios:

  • VM testing as primary validation method with specific cleanup procedures
  • Hardware-specific testing scenarios (recovery mode flashing, serial console setup, etc.)
  • Post-build validation checklist with format checks and license validation

Development Workflow:

  • Prerequisites including Nix installation and flakes configuration
  • Code quality checks (nix fmt, reuse lint) that must pass for CI
  • Security and compliance requirements with license header templates
  • Troubleshooting guidance for common build and runtime issues

Repository Navigation:

  • Key file locations and directory structure explanation
  • Development tools and testing modules documentation
  • Cross-compilation setup requirements with remote builder configuration

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.

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
Copilot AI requested a review from brianmcgillion September 4, 2025 03:11
@brianmcgillion
Copy link
Copy Markdown
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>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Sep 4, 2025

@copilot add .github/copilot-instructions.md to REUSE.toml under the line ".github/dependabot.yml", to fix the failing check

Added .github/copilot-instructions.md to REUSE.toml under the Apache-2.0 license section. This should fix the failing license check. Commit: 4a3e8c6

@brianmcgillion brianmcgillion merged commit 45b18c4 into main Sep 4, 2025
35 of 51 checks passed
@brianmcgillion brianmcgillion deleted the copilot/fix-1356 branch September 4, 2025 03:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

✨ Set up Copilot instructions

2 participants