From 0d16ab21e00c67a652211b2737e502b21250ae84 Mon Sep 17 00:00:00 2001 From: Marko Milic Date: Fri, 18 Oct 2024 13:32:41 +0200 Subject: [PATCH] refactor: update CONTRIBUTING.md --- CONTRIBUTING.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5409280a..9917e21e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,12 @@ We greatly appreciate contributions to the vscode-java-dependency project. Your efforts help us maintain and improve this extension. To ensure a smooth contribution process, please follow these guidelines. -## Setup Guide +## Prerequisites +- [JDK](https://www.oracle.com/java/technologies/downloads/?er=221886) +- [Node.JS](https://nodejs.org/en/) +- [VSCode](https://code.visualstudio.com/) + +## Build and Run To set up the vscode-java-dependency project, follow these steps: @@ -19,11 +24,12 @@ To set up the vscode-java-dependency project, follow these steps: npm install ``` -3. **Run the Extension**: +3. **Run/Debug the Extension**: - Open the "Run and Debug" view in Visual Studio Code. - Run the "Run Extension" task. -4. **Attach to Plugin**: +4. **Attach to Plugin[Debug Java]**: + - Prerequisite: Ensure that the extension is activated, meaning the Java process is already launched. This is required for the task to run properly. - Open the "Run and Debug" view in Visual Studio Code. - Run the "Attach to Plugin" task. - Note: This task is required only if you want to debug Java code [jdtls.ext](./jdtls.ext). It requires the [vscode-pde](https://marketplace.visualstudio.com/items?itemName=yaozheng.vscode-pde) extension to be installed.