Skip to content

Add GitHub Copilot instructions for file reference formatting#291

Draft
Copilot wants to merge 3 commits intodevelopfrom
copilot/update-file-link-provision
Draft

Add GitHub Copilot instructions for file reference formatting#291
Copilot wants to merge 3 commits intodevelopfrom
copilot/update-file-link-provision

Conversation

Copy link

Copilot AI commented Jan 19, 2026

Establishes guidelines for AI assistants to avoid guessing file paths and instead provide searchable file references.

Changes

  • Created .github/copilot-instructions.md with three core directives:
    1. Don't guess file paths when uncertain about location
    2. Provide file name and repository context separately
    3. Use repo:user/repo filename syntax for GitHub search compatibility

Example

Instead of providing potentially incorrect paths:

❌ "See /some/assumed/path/to/file.java"

Use searchable references:

✅ "See file.java - use repo:integratedmodelling/klab file.java to locate"
✅ "file.java is in the klab.engine module"

This ensures file references remain valid across repository restructuring and users can reliably locate files via GitHub search.

Original prompt

When providing file links, do not guess the path. Provide the file name and the repository structure separately, or use the repo:user/repo syntax so I can search for it. Apply thies to any future query, please


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 2 commits January 19, 2026 16:31
Co-authored-by: alessio-bulckaen <98831233+alessio-bulckaen@users.noreply.github.com>
Co-authored-by: alessio-bulckaen <98831233+alessio-bulckaen@users.noreply.github.com>
Copilot AI changed the title [WIP] Update file link provision method Add GitHub Copilot instructions for file reference formatting Jan 19, 2026
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.

2 participants