Skip to content

Improves tips and tricks docs and Fix links in contributing documentation#1951

Merged
hohwille merged 6 commits into
devonfw:mainfrom
AdemZarrouki:feature/improves-tips-and-tricks-docs
May 19, 2026
Merged

Improves tips and tricks docs and Fix links in contributing documentation#1951
hohwille merged 6 commits into
devonfw:mainfrom
AdemZarrouki:feature/improves-tips-and-tricks-docs

Conversation

@AdemZarrouki
Copy link
Copy Markdown
Contributor

@AdemZarrouki AdemZarrouki commented May 18, 2026

This PR fixes TodoIssueID

Implemented changes:

  • Added section on known CI build errors and quick fixes to contributing documentation
  • Fixed links in contributing documentation for consistency

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 18, 2026
@AdemZarrouki AdemZarrouki added the internal Nothing to be added to CHANGELOG, only internal story label May 18, 2026
@AdemZarrouki AdemZarrouki self-assigned this May 18, 2026
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented May 18, 2026

Coverage Report for CI Build 26106802075

Warning

Build has drifted: This PR's base is out of sync with its target branch, so coverage data may include unrelated changes.
Quick fix: rebase this PR. Learn more →

Coverage decreased (-0.02%) to 70.957%

Details

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

Uncovered Changes

No uncovered changes found.

Coverage Regressions

2 previously-covered lines in 1 file lost coverage.

File Lines Losing Coverage Coverage
com/devonfw/tools/ide/version/VersionSegment.java 2 89.24%

Coverage Stats

Coverage Status
Relevant Lines: 15511
Covered Lines: 11477
Line Coverage: 73.99%
Relevant Branches: 6928
Covered Branches: 4445
Branch Coverage: 64.16%
Branches in Coverage %: Yes
Coverage Strength: 3.13 hits per line

💛 - Coveralls

@AdemZarrouki AdemZarrouki marked this pull request as ready for review May 18, 2026 14:11
@AdemZarrouki AdemZarrouki moved this from 🆕 New to Team Review in IDEasy board May 18, 2026
Copy link
Copy Markdown
Member

@hohwille hohwille left a comment

Choose a reason for hiding this comment

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

@AdemZarrouki thanks for your PR. Great that you fixed several links and also you started some common problems section. 👍
Two quick thoughts:

  • shouldn't we move the FAQ/known problems to a separate asciidoc file? I expect this to grow and this would make the contributing.adoc hard to read.
  • the design.puml file should actually be moved to contributing since the design and architecture is also not intended for end-users but rather for contributors and developers of IDEasy.

Copy link
Copy Markdown
Member

@hohwille hohwille left a comment

Choose a reason for hiding this comment

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

@AdemZarrouki thanks for the update. Now perfect and ready for merge. 👍

@github-project-automation github-project-automation Bot moved this from Team Review to 👀 In review in IDEasy board May 19, 2026
@hohwille hohwille merged commit 908c0a7 into devonfw:main May 19, 2026
2 checks passed
@hohwille hohwille added this to the release:2026.05.001 milestone May 19, 2026
@github-project-automation github-project-automation Bot moved this from 👀 In review to ✅ Done in IDEasy board May 19, 2026
@AdemZarrouki
Copy link
Copy Markdown
Contributor Author

This was for improvement of the documentation and don't need to be retested. The label QA approved can be set.

@AdemZarrouki AdemZarrouki added the QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented. label May 20, 2026
@areinicke areinicke self-assigned this May 21, 2026
@areinicke areinicke self-requested a review May 21, 2026 07:27
@areinicke areinicke removed their assignment May 21, 2026
@areinicke areinicke removed their request for review May 21, 2026 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Nothing to be added to CHANGELOG, only internal story QA approved Label a PR that has been re-testet via nightly SNAPSHOT after merge and commented.

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

4 participants