Skip to content

chore: Add copilot instructions - #15

Merged
aymericmariaux merged 2 commits into
add-licenses-mdfrom
add-copilot-instructions
Aug 6, 2026
Merged

chore: Add copilot instructions#15
aymericmariaux merged 2 commits into
add-licenses-mdfrom
add-copilot-instructions

Conversation

@aymericmariaux

Copy link
Copy Markdown
Contributor

No description provided.

@aymericmariaux
aymericmariaux requested review from baillyjamy and a balanced review from Copilot August 6, 2026 14:06
@aymericmariaux aymericmariaux self-assigned this Aug 6, 2026

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds and corrects Copilot onboarding guidance for the Kotlin Multiplatform library.

Changes:

  • Adds build, validation, architecture, and review instructions.
  • Corrects namespace, package distribution, and JVM test commands.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
AGENTS.md Corrects project and testing documentation.
.github/copilot-instructions.md Adds Copilot coding-agent onboarding guidance.
Suppressed comments (2)

.github/copilot-instructions.md:42

  • appleTest is not a device-test source set: it feeds the iOS simulator and macOS test targets, which require a macOS host but not a physical device (also reflected by AGENTS.md:140-142). Labeling it as “device” can cause agents to skip runnable Apple tests or describe their validation requirements incorrectly.
                                       # commonTest/androidHostTest (no device), androidDeviceTest/appleTest (device)

.github/copilot-instructions.md:29

  • This contradicts line 21: build does not fail on Linux merely because Apple targets are present; Kotlin/Native skips those unsupported targets, so the command can succeed with incomplete Apple validation. Only the XCFramework task requires macOS here. Reword this so agents do not incorrectly report that build itself cannot be attempted on Linux.
macOS-only — do NOT attempt on Linux, they will fail; say so in the PR description instead of pretending they were verified:

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/copilot-instructions.md Outdated
@aymericmariaux
aymericmariaux force-pushed the add-copilot-instructions branch from 0b00fd2 to b5a1688 Compare August 6, 2026 14:13
@aymericmariaux
aymericmariaux merged commit 2dad0b3 into main Aug 6, 2026
6 checks passed
@aymericmariaux
aymericmariaux deleted the add-copilot-instructions branch August 6, 2026 14:40
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.

3 participants