Skip to content

Commit 25220db

Browse files
CopilotShreckYe
andcommitted
Address feedback: fix technical inaccuracies and remove version-specific details
Co-authored-by: ShreckYe <[email protected]>
1 parent 898b6c7 commit 25220db

File tree

1 file changed

+4
-21
lines changed

1 file changed

+4
-21
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
- **Build System**: Gradle with Kotlin DSL
1111
- **Target Platforms**: JVM, Android, iOS, JS (DOM), Wasm-JS (Canvas)
1212
- **Key Dependencies**: Compose Multiplatform, Kobweb Silk, Material Web Components
13-
- **Current Version**: 0.6.0-SNAPSHOT
1413

1514
## Build Instructions and Environment Setup
1615

@@ -63,7 +62,7 @@
6362

6463
2. **Memory Issues**: If Wasm compilation fails with OOM, the memory is already optimized in gradle.properties.
6564

66-
3. **Kotlin/JS Store**: The `kotlin-js-store` directory may be generated during JS builds - this should not be committed.
65+
3. **Kotlin/JS Store**: The `kotlin-js-store` directory may be generated during JS builds - this should be committed when updated automatically by Gradle commands.
6766

6867
4. **Gradle Daemon**: May timeout on first runs. Use `--no-daemon` flag if needed: `./gradlew check --no-daemon`
6968

@@ -99,7 +98,7 @@
9998
- **buildSrc/src/main/kotlin/VersionsAndDependencies.kt**: All dependency versions
10099
- **buildSrc/src/main/kotlin/common-conventions.gradle.kts**: Shared build configuration
101100
- **buildSrc/src/main/kotlin/lib-conventions.gradle.kts**: Library-specific configuration
102-
- **gradle.properties**: JVM memory settings and Kotlin MPP configuration
101+
- **gradle.properties**: JVM memory settings for Gradle (increase if OOM occurs) and Kotlin MPP configuration
103102
- **settings.gradle.kts**: Project structure and repository configuration
104103

105104
### Source Set Structure (Per Module)
@@ -114,21 +113,6 @@ src/
114113
└── iosMain/ # iOS-specific implementations
115114
```
116115

117-
### CI/CD Workflows
118-
119-
#### `.github/workflows/ci.yml`
120-
- **Trigger**: Push to any branch, manual dispatch
121-
- **Platforms**: ubuntu-latest, macos-latest, windows-latest
122-
- **JDK**: 17-temurin
123-
- **Commands**: Uses `huanshankeji/.github/actions/[email protected]`
124-
125-
#### `.github/workflows/demo-gh-pages.yml`
126-
- **Trigger**: Push/PR to `release` branch, manual dispatch
127-
- **Platform**: ubuntu-latest
128-
- **Purpose**: Builds and deploys demo to GitHub Pages
129-
- **Build Command**: `./gradlew :compose-multiplatform-html-unified-demo:sideBySideBrowserDistribution`
130-
- **Artifact Path**: `demo/build/dist/sideBySide/productionExecutable/`
131-
132116
### Dependencies and External Integration
133117

134118
#### Required External Repositories
@@ -169,8 +153,7 @@ repositories {
169153
- **Parameter Naming**: Parameters with "JsDom" or "ComposeUi" suffixes are platform-specific
170154

171155
#### Code Quality and Validation
172-
- **Binary Compatibility**: Enforced via kotlinx.validation plugin
173-
- **Code Style**: IntelliJ IDEA Code Cleanup and Reformat Code applied project-wide
156+
- **Binary Compatibility**: Enforced via org.jetbrains.kotlinx.binary-compatibility-validator plugin
174157
- **Limited Testing**: Project acknowledges "limited number of tests"
175158

176159
#### Architecture Notes
@@ -195,7 +178,7 @@ settings.gradle.kts # Project structure and dependency management
195178

196179
## Validation Steps for Changes
197180

198-
1. **Build Validation**: Run `./gradlew publishToMavenLocal` to ensure libraries compile
181+
1. **Build Validation**: Run `./gradlew publishToMavenLocal` or `./gradlew build` to ensure libraries compile
199182
2. **Test Validation**: Run `./gradlew check` to validate existing tests pass
200183
3. **Demo Validation**: Build demo with `./gradlew :compose-multiplatform-html-unified-demo:sideBySideBrowserDistribution`
201184
4. **CI Simulation**: Test on multiple platforms if possible (the CI runs on Ubuntu, macOS, Windows)

0 commit comments

Comments
 (0)