Skip to content

Commit 834bcde

Browse files
authored
docs: Document Copilot agent install step for local builds (#28)
1 parent d45436c commit 834bcde

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,26 @@ When you submit a pull request, a CLA bot will automatically determine whether y
1616

1717
### Prerequisites
1818

19-
- **Java 21** or later
19+
- **Java 17** or later (CI uses Temurin 17; use a newer JDK if required by your Eclipse IDE)
2020
- **Maven 3.8+** (or use the provided Maven wrapper `./mvnw`)
21+
- **Node.js 22.13** or later, with npm
2122
- **Eclipse IDE for Eclipse Committers 2024-03** or later (for development)
2223

2324
### Building the Project
2425

25-
Clone the repository and build with the Maven wrapper:
26+
Clone the repository, install the Copilot agent dependencies, and build with the Maven wrapper:
2627

2728
```shell
29+
cd com.microsoft.copilot.eclipse.core/copilot-agent
30+
npm i -f
31+
cd ../..
2832
./mvnw clean package
2933
```
3034

35+
The `npm i -f` step runs the Copilot agent `postinstall` script, which copies the language server files into
36+
`com.microsoft.copilot.eclipse.core/copilot-agent/dist/` and the platform-specific agent bundles required by the
37+
Tycho build. The `-f` flag matches CI and lets npm proceed if the agent dependency tree has conflicts.
38+
3139
### Running Tests
3240

3341
```shell
@@ -61,6 +69,9 @@ The installable P2 repository is generated in `com.microsoft.copilot.eclipse.rep
6169
2. Make your changes following the code style and architecture guidelines below.
6270
3. Ensure all checks pass before submitting:
6371
```shell
72+
cd com.microsoft.copilot.eclipse.core/copilot-agent
73+
npm i -f
74+
cd ../..
6475
./mvnw checkstyle:check # Code style compliance
6576
./mvnw clean verify # Compilation and packaging
6677
./mvnw test # Unit tests

0 commit comments

Comments
 (0)