Skip to content

Commit 5282f23

Browse files
committed
docs: Extend contribution guide
Describe how to import projects and how to run them in Eclipse
1 parent cad24a6 commit 5282f23

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 22 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,26 @@ 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 import additional projects using the import wizard for Maven project (without a `.project` file):
62+
Select *File > Import... > Maven > Existing Maven Projects*,
63+
* Do also import the agent bundle for your OS (e.g., `com.microsoft.copilot.eclipse.core.agent.win-x64`)
64+
after building the project with npm and maven or import all OS-specific agent bundles.
65+
2. Activate one of the target platforms, i.e. open one of the target definition files and select `Set As Active Target Platform`.
66+
* target-terminal.target (Eclipse 4.37+)
67+
* target-tm-terminal.target (Eclipse 4.36 and earlier)
68+
3. For using the Checkstyle configuration (assuming you have installed the Eclipse Checkstyle plugin, see prerequisites),
69+
add a new named Checkstyle configuration.
70+
* Select *Window > Preferences > Checkstyle* and press the *New...* button.
71+
* Select Type="Project Relative Configuration", **name="copilot4eclipse"**, and choose the location using the *Browse...* button.
72+
The `checkstyle.xml` file is in the git repository root folder in the project "github-copilot-for-eclipse".
73+
4. Use the launch configurations in the `launch/` directory, e.g. for launching a new Eclipse IDE with Copilot plug-ins.
74+
* Check the selected plug-ins in your launch configuration (in *Plug-ins* tab)and remove any OS-specific agent bundle that does not fit
75+
to your OS and remove all test bundles from the selected plug-ins from your Eclipse workspace.
76+
* Validate your config and ensure that all dependencies are resolved.
77+
Try *Select Required* button if something is missing.
5778

5879
## How to Contribute
5980

0 commit comments

Comments
 (0)