Skip to content

#1918: Add documentation on how to run IDEasy locally using intellij#1941

Open
satorus wants to merge 3 commits into
devonfw:mainfrom
satorus:feature/1918-add-local-run-instructions-to-dev-doc
Open

#1918: Add documentation on how to run IDEasy locally using intellij#1941
satorus wants to merge 3 commits into
devonfw:mainfrom
satorus:feature/1918-add-local-run-instructions-to-dev-doc

Conversation

@satorus
Copy link
Copy Markdown
Contributor

@satorus satorus commented May 13, 2026

This PR fixes #1918

Implemented changes:

  • Added documentation for contributors on how to run and debug IDEasy with local changes in Intellij.
  • Converted markdown listing style to asciidoc style (since intellij commit check was unhappy about it)

Checklist for this PR

Make sure everything is checked before merging this PR. For further info please also see
our DoD.

  • When running mvn clean test locally all tests pass and build is successful
  • PR title is of the form #«issue-id»: «brief summary» (e.g. #921: fixed setup.bat). If no issue ID exists, title only.
  • PR top-level comment summarizes what has been done and contains link to addressed issue(s)
  • PR and issue(s) have suitable labels
  • Issue is set to In Progress and assigned to you or there is no issue (might happen for very small PRs)
  • You followed all coding conventions
  • You have added the issue implemented by your PR in CHANGELOG.adoc unless issue is labeled
    with internal

@github-project-automation github-project-automation Bot moved this to 🆕 New in IDEasy board May 13, 2026
@satorus satorus added documentation Improvements or additions to documentation enhancement New feature or request labels May 13, 2026
@satorus satorus self-assigned this May 13, 2026
@satorus satorus moved this from 🆕 New to Team Review in IDEasy board May 13, 2026
@satorus satorus marked this pull request as ready for review May 13, 2026 12:22
@areinicke areinicke self-assigned this May 13, 2026
@areinicke areinicke self-requested a review May 13, 2026 12:24
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented May 13, 2026

Coverage Report for CI Build 25924450796

Coverage decreased (-0.02%) to 70.66%

Details

  • Coverage decreased (-0.02%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 1 coverage regression across 1 file.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

1 previously-covered line in 1 file lost coverage.

File Lines Losing Coverage Coverage
com/devonfw/tools/ide/version/VersionSegment.java 1 89.76%

Coverage Stats

Coverage Status
Relevant Lines: 15475
Covered Lines: 11396
Line Coverage: 73.64%
Relevant Branches: 6918
Covered Branches: 4427
Branch Coverage: 63.99%
Branches in Coverage %: Yes
Coverage Strength: 3.11 hits per line

💛 - Coveralls

Copy link
Copy Markdown
Contributor

@areinicke areinicke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job! This should make it easier for new joiners or other people to test their changes. Please consider the one comment I left.

Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
@satorus satorus requested a review from areinicke May 15, 2026 11:30
Copy link
Copy Markdown
Contributor

@areinicke areinicke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job! Your explanations are very detailed and it is easy to follow along. I have tested all the ways you provided and everything seems to be correct.

I have commented on some minor issues that should be resolved before merging.

Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Comment thread documentation/contributing/run-ideasy-locally.adoc Outdated
Co-authored-by: Alexander Reinicke <167530118+areinicke@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

Status: Team Review

Development

Successfully merging this pull request may close these issues.

Onboarding documentation improvement

3 participants