Skip to content

Commit 3f0a5d4

Browse files
travkin79travkin79
authored
Extend CONTRIBUTING.md and adapt some Eclipse project settings to simplify getting started (#176)
1 parent 382e03e commit 3f0a5d4

21 files changed

Lines changed: 264 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ When you submit a pull request, a CLA bot will automatically determine whether y
2020
- **Maven 3.8+** (or use the provided Maven wrapper `./mvnw`)
2121
- **Node.js 22.13** or later, with npm
2222
- **Eclipse IDE for Eclipse Committers 2024-03** or later (for development)
23+
- Recommended: **Eclipse Checkstyle plugin** for code style compliance
24+
(e.g. install from update site: https://checkstyle.org/eclipse-cs-update-site/)
2325

2426
### Building the Project
2527

@@ -53,7 +55,24 @@ The installable P2 repository is generated in `com.microsoft.copilot.eclipse.rep
5355
### Running in Eclipse
5456

5557
1. Import all modules into your Eclipse workspace.
56-
2. Use the launch configurations in the `launch/` directory.
58+
* Select *File > Import... > General > Existing projects into Workspace*,
59+
select the root directory of the copilot-for-eclipse git repo,
60+
activate the check box *Search for nested projects*, and finish the wizard.
61+
* Do also import the agent bundle for your OS (e.g., `com.microsoft.copilot.eclipse.core.agent.win32`)
62+
after building the project with npm and maven or import all OS-specific agent bundles.
63+
2. Activate one of the target platforms, i.e. open one of the target definition files and select `Set As Active Target Platform`.
64+
* target-terminal.target (Eclipse 4.37+)
65+
* target-tm-terminal.target (Eclipse 4.36 and earlier)
66+
3. For using the Checkstyle configuration (assuming you have installed the Eclipse Checkstyle plugin, see prerequisites),
67+
add a new named Checkstyle configuration.
68+
* Select *Window > Preferences > Checkstyle* and press the *New...* button.
69+
* Select Type="Project Relative Configuration", **name="copilot4eclipse"**, and choose the location using the *Browse...* button.
70+
The `checkstyle.xml` file is in the git repository root folder in the project "github-copilot-for-eclipse".
71+
4. Use the launch configurations in the `launch/` directory, e.g. for launching a new Eclipse IDE with Copilot plug-ins.
72+
* Check the selected plug-ins in your launch configuration (in *Plug-ins* tab) and remove any OS-specific agent bundle that does not fit
73+
to your OS and remove all test bundles from the selected plug-ins from your Eclipse workspace.
74+
* Validate your config and ensure that all dependencies are resolved.
75+
Try *Select Required* button if something is missing.
5776

5877
## How to Contribute
5978

‎com.microsoft.copilot.eclipse.branding/.project‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.microsoft.copilot.eclipse.branding</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.pde.SchemaBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
<buildCommand>
19+
<name>org.eclipse.m2e.core.maven2Builder</name>
20+
<arguments>
21+
</arguments>
22+
</buildCommand>
23+
</buildSpec>
24+
<natures>
25+
<nature>org.eclipse.m2e.core.maven2Nature</nature>
26+
<nature>org.eclipse.pde.PluginNature</nature>
27+
</natures>
28+
</projectDescription>

‎com.microsoft.copilot.eclipse.branding/.settings/org.eclipse.m2e.core.prefs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
activeProfiles=
2+
eclipse.preferences.version=1
3+
resolveWorkspaceProjects=true
4+
version=1

‎com.microsoft.copilot.eclipse.core.agent.linux.aarch64/.project‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.microsoft.copilot.eclipse.core.agent.linux.aarch64</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.pde.SchemaBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
<buildCommand>
19+
<name>org.eclipse.m2e.core.maven2Builder</name>
20+
<arguments>
21+
</arguments>
22+
</buildCommand>
23+
</buildSpec>
24+
<natures>
25+
<nature>org.eclipse.m2e.core.maven2Nature</nature>
26+
<nature>org.eclipse.pde.PluginNature</nature>
27+
</natures>
28+
</projectDescription>

‎com.microsoft.copilot.eclipse.core.agent.linux.aarch64/.settings/org.eclipse.m2e.core.prefs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
activeProfiles=
2+
eclipse.preferences.version=1
3+
resolveWorkspaceProjects=true
4+
version=1

‎com.microsoft.copilot.eclipse.core.agent.linux.x64/.project‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.microsoft.copilot.eclipse.core.agent.linux.x64</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.pde.SchemaBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
<buildCommand>
19+
<name>org.eclipse.m2e.core.maven2Builder</name>
20+
<arguments>
21+
</arguments>
22+
</buildCommand>
23+
</buildSpec>
24+
<natures>
25+
<nature>org.eclipse.m2e.core.maven2Nature</nature>
26+
<nature>org.eclipse.pde.PluginNature</nature>
27+
</natures>
28+
</projectDescription>

‎com.microsoft.copilot.eclipse.core.agent.linux.x64/.settings/org.eclipse.m2e.core.prefs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
activeProfiles=
2+
eclipse.preferences.version=1
3+
resolveWorkspaceProjects=true
4+
version=1

‎com.microsoft.copilot.eclipse.core.agent.macosx.aarch64/.project‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.microsoft.copilot.eclipse.core.agent.macosx.aarch64</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.pde.SchemaBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
<buildCommand>
19+
<name>org.eclipse.m2e.core.maven2Builder</name>
20+
<arguments>
21+
</arguments>
22+
</buildCommand>
23+
</buildSpec>
24+
<natures>
25+
<nature>org.eclipse.m2e.core.maven2Nature</nature>
26+
<nature>org.eclipse.pde.PluginNature</nature>
27+
</natures>
28+
</projectDescription>

‎com.microsoft.copilot.eclipse.core.agent.macosx.aarch64/.settings/org.eclipse.m2e.core.prefs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
activeProfiles=
2+
eclipse.preferences.version=1
3+
resolveWorkspaceProjects=true
4+
version=1

‎com.microsoft.copilot.eclipse.core.agent.macosx.x64/.project‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<projectDescription>
3+
<name>com.microsoft.copilot.eclipse.core.agent.macosx.x64</name>
4+
<comment></comment>
5+
<projects>
6+
</projects>
7+
<buildSpec>
8+
<buildCommand>
9+
<name>org.eclipse.pde.ManifestBuilder</name>
10+
<arguments>
11+
</arguments>
12+
</buildCommand>
13+
<buildCommand>
14+
<name>org.eclipse.pde.SchemaBuilder</name>
15+
<arguments>
16+
</arguments>
17+
</buildCommand>
18+
<buildCommand>
19+
<name>org.eclipse.m2e.core.maven2Builder</name>
20+
<arguments>
21+
</arguments>
22+
</buildCommand>
23+
</buildSpec>
24+
<natures>
25+
<nature>org.eclipse.m2e.core.maven2Nature</nature>
26+
<nature>org.eclipse.pde.PluginNature</nature>
27+
</natures>
28+
</projectDescription>

0 commit comments

Comments
 (0)