Add .github/copilot-instructions.md to onboard Copilot coding agents

[Copilot]

This PR adds comprehensive instructions for Copilot coding agents to work efficiently in this repository by creating .github/copilot-instructions.md.

Problem

Coding agents working on this repository need to spend significant time exploring the codebase to understand:

• How to build, test, and validate changes
• The multi-module project structure and architecture
• Known issues, workarounds, and compatibility requirements
• Key file locations and development workflows

This exploration time increases the likelihood of build failures and reduces agent efficiency.

Solution

The new .github/copilot-instructions.md file provides:

Repository Overview

• Clear description of the Gradle plugin library with multiple modules
• Technology stack: Gradle 9.0.0, Kotlin 2.2.20, JDK 17+ compatibility
• Project scope and API stability expectations

Validated Build Instructions

All commands tested and include execution times:

• ./gradlew build - Full build (~30 seconds)
• ./gradlew check - Validation without distributions (~1 minute)
• ./gradlew publishToMavenLocal - Local publishing (~2 seconds)
• ./gradlew apiCheck - API compatibility validation
• ./gradlew dokkaGeneratePublicationHtml - Documentation generation

Project Architecture

• 4 main modules: kotlin-common-gradle-plugins, architecture-common-gradle-plugins, common-gradle-dependencies, huanshankeji-team-gradle-plugins
• Key configuration files and their purposes
• CI/CD pipeline details (GitHub Actions with JDK 17)
• Dependency management and version compatibility

Known Issues & Workarounds

• Kotlin version warnings (safe to ignore)
• Memory requirements (-Xmx2G needed for architecture module)
• IntelliJ IDEA 2024.3 compatibility issue (IDEA-363846)
• Bootstrap dependency resolution (may need to build common-gradle-dependencies first)

Development Guidelines

• IDE setup recommendations for IntelliJ IDEA
• Plugin development workflow with publishToMavenLocal
• Version alignment strategies

Updates Made

After merging the dev branch, the instructions were updated to reflect the latest versions:

• Updated Gradle version from 8.11.1 to 9.0.0
• Updated Kotlin version from 2.1.0 to 2.2.20
• Updated Compose Multiplatform version from 1.7.1 to 1.10.0-alpha01
• Updated Dokka version from 2.0.0 to 2.1.0-Beta
• Updated Binary Compatibility Validator version from 0.16.3 to 0.18.1
• Updated Gradle Plugin Publish Plugin version to 2.0.0
• Corrected JDK version requirements from JDK 8+ to JDK 17+ (required by Gradle 9.0.0)
• Removed outdated Dokka V2 migration messages
• Clarified that Kotlin version warnings are normal behavior
• Added note about potential bootstrap dependency issues after version updates

Benefits

This documentation will:

• Reduce coding agent exploration time
• Minimize build failures and command errors
• Provide immediate context about project structure
• Document validated workflows and common pitfalls
• Enable agents to focus on implementation rather than discovery

The instructions are comprehensive yet concise, fitting within 2 pages while covering all essential information needed for effective development in this repository.

---

💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

[ShreckYe]

@copilot I have merged dev into this branch. Please update accordingly.

[Copilot]

@copilot I have merged dev into this branch. Please update accordingly.

Updated the copilot instructions to reflect the dev branch merge. Updated all version references:

• Gradle: 8.11.1 → 9.0.0
• Kotlin: 2.1.0 → 2.2.20
• Compose Multiplatform: 1.7.1 → 1.10.0-alpha01
• Dokka: 2.0.0 → 2.1.0-Beta
• Binary Compatibility Validator: 0.16.3 → 0.18.1

Also added a note about potentially needing to build common-gradle-dependencies first if dependency resolution fails. All build commands validated and working with the updated versions. (commit: 3746dc8)

[ShreckYe]

@copilot

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[Copilot]

@copilot

Addressed all the review feedback: updated JDK version requirements to 17+, corrected version references, removed outdated Dokka messages, and clarified build behavior explanations. All changes tested and validated. (commit: 77db21b)