From c9aaa14aa8c61fec1ca795e6e1799220f7893200 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 19 Jan 2026 16:29:25 +0000 Subject: [PATCH 1/3] Initial plan From d913dabc6d13a5535dd086ed47419cfd0db93b47 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 19 Jan 2026 16:31:52 +0000 Subject: [PATCH 2/3] Add GitHub Copilot instructions for file link provision Co-authored-by: alessio-bulckaen <98831233+alessio-bulckaen@users.noreply.github.com> --- .github/copilot-instructions.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/copilot-instructions.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 000000000..a60e98f1f --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,30 @@ +# GitHub Copilot Instructions for k.LAB Repository + +## File Link Provision Guidelines + +When providing file references or links in responses: + +1. **Do not guess the file path** - If you're uncertain about the exact location of a file, do not provide a guessed or assumed path. + +2. **Provide information separately** - Instead of guessing, provide: + - The file name (e.g., `Jenkinsfile`, `pom.xml`) + - The repository structure or directory context separately + +3. **Use searchable syntax** - When referencing files, use the `repo:user/repo` syntax to enable easy searching: + - Example: `repo:integratedmodelling/klab` + - This allows users to search for the file themselves without following potentially incorrect paths + +## Example + +❌ **Incorrect**: "You can find this in `/some/assumed/path/to/file.java`" + +✅ **Correct**: "You can find this file named `file.java` in the repository. Use `repo:integratedmodelling/klab file.java` to search for it." + +✅ **Also Correct**: "The file `file.java` is located in the klab.engine module. The repository structure follows a Maven multi-module layout." + +## Rationale + +This guideline ensures that: +- Users are not misled by incorrect or outdated path information +- Users can reliably locate files using GitHub's search functionality +- The repository structure remains flexible for reorganization without breaking documentation From c57b280c359fddf9cd7dcc7603c5baa2cefd8cba Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 19 Jan 2026 16:32:35 +0000 Subject: [PATCH 3/3] Improve example to show complete repo syntax with filename Co-authored-by: alessio-bulckaen <98831233+alessio-bulckaen@users.noreply.github.com> --- .github/copilot-instructions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index a60e98f1f..2df162ae8 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -11,7 +11,7 @@ When providing file references or links in responses: - The repository structure or directory context separately 3. **Use searchable syntax** - When referencing files, use the `repo:user/repo` syntax to enable easy searching: - - Example: `repo:integratedmodelling/klab` + - Example: `repo:integratedmodelling/klab filename.java` - This allows users to search for the file themselves without following potentially incorrect paths ## Example