Add Copilot CLI instructions for the repository#1446
Open
benhillis wants to merge 1 commit into
Open
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
aac68d6 to
7d5a321
Compare
There was a problem hiding this comment.
Pull request overview
Adds a new .github/copilot-instructions.md providing Copilot CLI sessions with repository-specific context: layout, build commands (including the vendor/ working-branch requirement and the 7 required --build-args), runtime architecture, and conventions. Doc-only; no code or build impact.
Changes:
- Documents repo layout and component roles (
WSLGd,rdpapplist,WSLDVCPlugin,vendor/, etc.). - Documents build flow: vendor clone,
build-and-export.sh, manualdocker buildargs, debug-build flag, per-component Meson commands. - Documents architecture/runtime flow and conventions (build order, intentional option minimisations, logging macros, FreeRDP v2/v3 fallback, debuginfo split, runtime-prune, read-only rootfs).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Adds
.github/copilot-instructions.mdso future Copilot CLI sessions in this repo start with the right context.What's covered
Dockerfile/build-and-export.sh,WSLGd,rdpapplist,WSLDVCPlugin,vendor/,config/,debuginfo/,devops/,package/) and that the WSLDVCPlugin builds separately on Windows.working-branch caveat (maintracks upstream and won't build), the preferred./build-and-export.shflow, the 7 required--build-args and the fail-fast placeholder rules (""/<unknown>/<current>/unknownrejected;"dev"is the local-fallback sentinel),SYSTEMDISTRO_DEBUG_BUILD=truefor debug VHDs, per-componentmeson build && ninjafor iteration, and the.wslconfigsystemDistro=swap for try-out.swrast+d3d12, no LLVM/Vulkan; Weston: RDP backend only,rdprail-shell; FreeRDP: server-only, channelGFXREDIR+RDPAPPLISTon; PulseAudio: simple DB, no tests). At runtimewsl.confbootsWSLGdas the userwslg, which launches Weston / PulseAudio /msrdc|mstsc, restarts crashed children, and shares state under/mnt/wslg(SHARE_PATH).LOG_ERROR/LOG_INFOmacros fromWSLGd/common.h(not rawfprintf); FreeRDP/WinPR v3-then-v2 dependency fallback in both Meson files;/etc/versions.txtgeneration + the historical reason for the fail-fast loop;debuginfo/strip_debuginfo.shper built component with a matching.listfile; aggressive runtime-image RPM/file purge in the non-debug path; read-only VHD at runtime → permanent changes belong in theDockerfile; upstream-component changes belong in themicrosoft/*-mirrorworkingbranches, not this repo.Doc-only change, no code or build impact.