Skip to content

#2110 add documentation for contributing to UI components - #2291

Open
laim2003 wants to merge 6 commits into
devonfw:mainfrom
laim2003:#2110-add-documentation-for-contributing-to-ui-components-clean
Open

#2110 add documentation for contributing to UI components#2291
laim2003 wants to merge 6 commits into
devonfw:mainfrom
laim2003:#2110-add-documentation-for-contributing-to-ui-components-clean

Conversation

@laim2003

@laim2003 laim2003 commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

This PR fixes #2110

Implemented changes:

  • Updated the PR template to include GUI checklist
  • Added documentation for the process of contributing to the GUI
  • Added documentation for the basic structure/architecture of the GUI

Testing instructions

No testing possible, as this is only a documentation update.


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
  • You have formulated clear instructions on how to test your contribution under "Testing instructions"

Signed-off-by: laim2003 <luk.faber@gmx.de>
@github-project-automation github-project-automation Bot moved this to 🆕 New in IDEasy board Aug 7, 2026
@laim2003 laim2003 moved this from 🆕 New to 🏗 In progress in IDEasy board Aug 7, 2026
@laim2003 laim2003 removed the status in IDEasy board Aug 7, 2026
@laim2003 laim2003 self-assigned this Aug 7, 2026
@laim2003 laim2003 moved this to Team Review in IDEasy board Aug 7, 2026
@laim2003 laim2003 added documentation Improvements or additions to documentation GUI Graphical User Interface of IDEasy (aka dashboard) build with JavaFx internal Nothing to be added to CHANGELOG, only internal story labels Aug 7, 2026
@laim2003
laim2003 marked this pull request as ready for review August 7, 2026 08:34
@coveralls

coveralls commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Coverage Report for CI Build 31963413086

Warning

No base build found for commit 31dabbf on main.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 72.918%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 17548
Covered Lines: 13342
Line Coverage: 76.03%
Relevant Branches: 7757
Covered Branches: 5110
Branch Coverage: 65.88%
Branches in Coverage %: Yes
Coverage Strength: 3.23 hits per line

💛 - Coveralls

@laim2003
laim2003 requested a review from JoelAdbu August 7, 2026 08:39
@laim2003 laim2003 changed the title #2110 add documentation for contributing to UI components clean #2110 add documentation for contributing to UI components Aug 7, 2026
Signed-off-by: laim2003 <luk.faber@gmx.de>

@JoelAdbu JoelAdbu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed the documentation. Looks very good to me, with a solid level of detail and practical examples. The architecture decisions and recommended patterns as well as the contribution process are explained clearly and should provide good guidance for future contributors.

@JoelAdbu JoelAdbu moved this from Team Review to 👀 In review in IDEasy board Aug 10, 2026
@laim2003
laim2003 requested a review from hohwille August 10, 2026 08:36
Comment on lines +68 to +91
gui/
├── src/
│ └── main/
│ └── java/
│ └── com/ideasy/gui/
│ ├── feature/
│ │ ├── dashboard/
│ │ │ ├── DashboardController.java
│ │ │ ├── DashboardModel.java
│ │ │ ├── DashboardView.java
│ │ │ └── component/
│ │ ├── settings/
│ │ │ ├── SettingsController.java
│ │ │ ├── SettingsModel.java
│ │ │ ├── SettingsView.java
│ │ │ └── component/
│ │ └── package-manager/
│ │ ├── PackageManagerController.java
│ │ ├── PackageManagerModel.java
│ │ ├── PackageManagerView.java
│ │ and component/
│ ├── component/ # Shared generic components (Button, Table, Dialog, etc.)
│ ├── util/ # UI utilities (bindings, converters, CSS helpers)
│ └── event/ # Event bus and custom events

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This is a recommended structure that I still need some feedback on.

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 GUI Graphical User Interface of IDEasy (aka dashboard) build with JavaFx internal Nothing to be added to CHANGELOG, only internal story

Projects

Status: 👀 In review

Development

Successfully merging this pull request may close these issues.

Add documentation for contributing to UI components

4 participants