|
1 | | -# Contributing |
2 | | - |
3 | | -## Running the Extension |
4 | | - |
5 | | -With Visual Studio Code: |
6 | | - |
7 | | -- Clone this repository locally. |
8 | | -- Run `npm install` in the cloned `codewind-java-profiler` folder. This installs all necessary npm modules in the client directory. |
9 | | -- Open the clone of this repository in Visual Studio Code. |
10 | | -- Press Ctrl+Shift+B (Cmd+Shift+B on Mac) to compile the client. |
11 | | -- Switch to the Debug viewlet. |
12 | | -- Select `Launch Client` from the drop down and press the Run icon. |
13 | | - |
14 | | -## Testing |
15 | | - |
16 | | -### Integration Tests |
17 | | - |
18 | | -To be added |
19 | | - |
20 | | -### Server Tests |
21 | | - |
22 | | -Unit tests for the Java Server are in the `server/src/test` directory. These are JUnit unit tests, but can only be run inside the server Docker container. |
23 | | - |
24 | | -To run the container complete the following steps: |
25 | | - |
26 | | -- Run `docker build -t java-ls .` in the `server` directory. |
27 | | -- Run `docker run -it java-ls bash`. |
28 | | -- In the `/profiling` directory, run `mvn test`. |
29 | | -- You will see a summary of all tests run. |
30 | | - |
31 | | -## Building/Installing the Extension |
32 | | - |
33 | | -To build a `.vsix` extension package that can then be installed/published: |
34 | | - |
35 | | -- Run `npm install` in the `codewind-java-profiler` folder. |
36 | | -- Install the `vsce` package globally with `npm install -g vsce`. |
37 | | -- Run `vsce package` in the `codewind-java-profiler` folder. |
38 | | -- A `.vsix` file will then be generated. |
39 | | - |
40 | | -To install the extension: |
41 | | - |
42 | | -- Run `code --install-extension <name of generated vsix file>` in the `codewind-java-profiler` folder. |
43 | | -- Restart Visual Studio Code. |
44 | | -- The extension should appear in your list of installed extensions. |
45 | | - |
46 | | -For more information refer to: <https://code.visualstudio.com/api/working-with-extensions/publishing-extension> |
| 1 | +## Contributing |
| 2 | +Thank you for your interest in contributing to Codewind. We welcome your additions to this project. |
| 3 | + |
| 4 | +#### Signing the Eclipse Contributor Agreement (ECA) |
| 5 | +Before you can contribute to any Eclipse project, you need to sign the [Eclipse Contributor Agreement (ECA)](https://www.eclipse.org/legal/ECA.php). |
| 6 | +1. To verify that you signed the ECA, sign in to [https://accounts.eclipse.org/ your Eclipse account]. |
| 7 | +2. View your **Status** and make sure that a check mark appears with the **Eclipse Contributor Agreement**. |
| 8 | +3. If the check mark does not appear, click the **Eclipse Contributor Agreement** in the **Status** box to go to the agreement that you need to sign. |
| 9 | +4. Fill the form and click the **Accept** button. |
| 10 | + |
| 11 | +#### Associating your Eclipse profile with your GitHub ID |
| 12 | +1. From your Eclipse account, select **Edit Profile**. |
| 13 | +2. On the **Personal Information** tab, go to the **Social Media Links** section and add your GitHub user name to the **GitHub Username** field. |
| 14 | +3. Answer the **Have you changed employers** question. |
| 15 | +4. Enter your Eclipse password in the **Current password** field and then click **Save**. |
| 16 | + |
| 17 | +For more information about Codewind workflows, see the [Codewind GitHub Workflows wiki](https://wiki.eclipse.org/Codewind_GitHub_Workflows). |
| 18 | + |
| 19 | +#### Checking if your issue is already addressed |
| 20 | +- Search the [list of issues](https://github.com/eclipse/codewind/issues) to see if your issue has already been raised. |
| 21 | +- See the [Codewind documentation](https://www.eclipse.org/codewind/docindex.html) to see if existing documentation addresses your question or concern. |
| 22 | + |
| 23 | +#### Creating a new issue |
| 24 | +If you do not see your issue, please [select the issue type in the Codewind repository to open a new issue](https://github.com/eclipse/codewind/issues/new/choose). |
| 25 | +- **Bugs:** Complete the bug template to report problems found in Codewind. |
| 26 | +- **Enhancements:** Complete the enhancement template to suggest improvements to Codewind. |
| 27 | +- **Questions:** Complete the question template to ask a question about Codewind. |
| 28 | + |
| 29 | +## Contact us |
| 30 | +If you have questions, please visit us on [Mattermost](https://mattermost.eclipse.org/eclipse/channels/eclipse-codewind). |
0 commit comments