Conversation
…/1708-newdoku-contributing-setup
|
|
Pull Request Test Coverage Report for Build 22220091006Details
💛 - Coveralls |
hohwille
changed the title
hohwille
left a comment
hohwille
left a comment
There was a problem hiding this comment.
@ymohandi thanks for your first PR. Great job - you already mastered AsciiDoc and have produced a very good and clear guide for the initial setup. 👍
I left some comments for improvement - mainly as constructive comments. When you go to Files changed tab you can select all of them together as batch and commit in one click if you accept my suggestions what automatically resolves these review threads.
|
|
||
| *Quick start*: + | ||
| Download the latest release of IDEasy https://github.com/devonfw/IDEasy/releases[here]. + | ||
| Extract the contents of the downloaded archive (`ide-cli-*.tar.gz`) to a new folder and run `setup` in this folder (on Windows, double-click `setup.bat`). |
There was a problem hiding this comment.
I am not so sure if we should repeat this over and over. IMHO the link below is sufficient.
For Windows I would even rather recommend the MSI installer.
| This should create an IDEasy folder inside your `projects` folder (e.g., `D:\projects\IDEasy`) populated with the project. + | ||
| On Windows, for example, under `C:\Users\«username»\projects`. If the `projects` folder does not exist, IDEasy will create it automatically and store the project there. |
There was a problem hiding this comment.
I like that you explain things and give examples. However, isn't it confusing that you first give D:\projects\IDEasy as example and then in the next sentence a C:\Users\«username»\projects.
If the
projectsfolder does not exist, IDEasy will create it automatically and store the project there.
I would remove this sentence. We are doing a fresh setup here so why should that folder already exist.
If it would really exist already this would more likely indicate a problem and IDEasy would log a warning and ask for confirmation to continue.
| . Inside the IDEasy folder in `projects\IDEasy`, navigate to `workspaces/main` in Windows Explorer. + | ||
| Right‑click on it and choose *Open Git Bash here* (on Windows 11 use *More options → Open Git Bash here*). + | ||
| Run this command: |
There was a problem hiding this comment.
The icd command works from anywhere so you do not need to navigate to special folders and do not need Windows Explorer.
| . Inside the IDEasy folder in `projects\IDEasy`, navigate to `workspaces/main` in Windows Explorer. + | |
| Right‑click on it and choose *Open Git Bash here* (on Windows 11 use *More options → Open Git Bash here*). + | |
| Run this command: | |
| . Start a bash terminal (on Windows open `Git Bash` from the Start Menu) and run the following command: |
| + | ||
| NOTE: Make sure your Git configuration matches your GitHub account: | ||
| + | ||
| ``` | ||
| git config user.name "«my_github_login»" | ||
| git config user.email "«my_github_user_email»" | ||
| ``` |
There was a problem hiding this comment.
I would recommend to move that to the prerequisites section.
Further user.name does not have to be your github login.
I have this in my .gitconfig:
[user]
name = Jörg Hohwiller
I think we can remove the NOTE.
|
|
||
| * *IDE* of your choice + | ||
| We recommend *IntelliJ*. Install it from: https://www.jetbrains.com/idea/download/?section=windows |
There was a problem hiding this comment.
Of course we use IDEasy to install Intellij. Since you have perfectly addressed this below in 6. I would just remove this.
| * *IDE* of your choice + | |
| We recommend *IntelliJ*. Install it from: https://www.jetbrains.com/idea/download/?section=windows |
| . To build the project and download all dependencies, run: | ||
| + | ||
| ``` | ||
| ide mvn clean install | ||
| ``` |
There was a problem hiding this comment.
should we maybe move this step up (before intellij)? Would make more sense to me.
| Further, browsing the JavaDoc of the source code will help you understand the different types and structures of the project. | ||
| For an architectural overview, see the link:images/design.puml[design diagram] (requires PlantUML support, e.g., via IntelliJ plugin). + | ||
| The screenshot below shows the UML diagram as of *2026‑02‑19*: | ||
|
|
||
| image::images/design-uml-overview-2026-02.png[IDEasy UML Overview, width=800] | ||
|
|
||
|
|
There was a problem hiding this comment.
Excellent. However, I would not include the PNG file that will outdate quickly.
Developers should be smart enough to visualise the puml file with IntelliJ from the recent state.
| Further, browsing the JavaDoc of the source code will help you understand the different types and structures of the project. | |
| For an architectural overview, see the link:images/design.puml[design diagram] (requires PlantUML support, e.g., via IntelliJ plugin). + | |
| The screenshot below shows the UML diagram as of *2026‑02‑19*: | |
| image::images/design-uml-overview-2026-02.png[IDEasy UML Overview, width=800] | |
| Further, browsing the JavaDoc of the source code will help you understand the different types and structures of the project. | |
| For an architectural overview, see the link:images/design.puml[design diagram] (requires PlantUML support, e.g., via IntelliJ plugin). |
| You can run this in any terminal, or directly in your IDE’s terminal. + | ||
| In IntelliJ, click the **Terminal** tab at the bottom (or press `Alt+F12`). + | ||
| Make sure your terminal’s current directory is `workspaces/main/IDEasy` before running the command. | ||
|
|
There was a problem hiding this comment.
This would also be the perfect spot to reference this guide:
https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-testing-linux-on-windows.adoc
I would add this as a last step since I recommend this for every developer.
However, we should note that this only applies to Windows users.
| In IntelliJ, click the **Terminal** tab at the bottom (or press `Alt+F12`). + | ||
| Make sure your terminal’s current directory is `workspaces/main/IDEasy` before running the command. | ||
|
|
||
| Your setup is now complete. Before you start contributing, we recommend reviewing the documentation to get familiar with the IDEasy project. Afterwards, you can continue with the https://github.com/devonfw/IDEasy/blob/main/documentation/IDEasy-contribution-rules-and-guidelines.adoc[Contribution Guidelines]. |
There was a problem hiding this comment.
Note: With #1709 you should update this link again.
Further, avoid putting absolute https: links here and use relative links:
link:IDEasy-contribution-rules-and-guidelines.adoc[Contribution Guidelines]
4 participants
This PR fixes #1708
New doku contributing setup
Implemented changes:
Add a step-by-step setup guide for new developers to install and configure IDEasy.
Checklist for this PR
Make sure everything is checked before merging this PR. For further info please also see
our DoD.
mvn clean testlocally all tests pass and build is successful#«issue-id»: «brief summary»(e.g.#921: fixed setup.bat). If no issue ID exists, title only.In Progressand assigned to you or there is no issue (might happen for very small PRs)with
internal