Skip to content

restructured and reworked contributing documentation#1793

Merged
hohwille merged 2 commits intodevonfw:mainfrom
hohwille:feature/restructure-internal-documentation
Apr 2, 2026
Merged

restructured and reworked contributing documentation#1793
hohwille merged 2 commits intodevonfw:mainfrom
hohwille:feature/restructure-internal-documentation

Conversation

@hohwille
Copy link
Copy Markdown
Member

@hohwille hohwille commented Apr 1, 2026

This PR improves the documentation for contributing developers

Implemented changes:

  • Move all contributing documentation to a contributing sub-folder.
  • Rename the documentation files to short and speaking names.
  • Added some missing aspects to that documentation.
  • Split some documents into smaller pieces.

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

@hohwille hohwille added this to the release:2026.04.001 milestone Apr 1, 2026
@hohwille hohwille self-assigned this Apr 1, 2026
@hohwille hohwille added documentation Improvements or additions to documentation enhancement New feature or request internal Nothing to be added to CHANGELOG, only internal story labels Apr 1, 2026
@github-project-automation github-project-automation bot moved this to 🆕 New in IDEasy board Apr 1, 2026
@hohwille hohwille moved this from 🆕 New to Team Review in IDEasy board Apr 1, 2026
@coveralls
Copy link
Copy Markdown
Collaborator

coveralls commented Apr 1, 2026

Pull Request Test Coverage Report for Build 23853367041

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage increased (+0.009%) to 70.643%

Totals Coverage Status
Change from base Build 23822201076: 0.009%
Covered Lines: 10886
Relevant Lines: 14791

💛 - Coveralls

@hohwille hohwille merged commit 9feab8b into devonfw:main Apr 2, 2026
3 checks passed
@github-project-automation github-project-automation bot moved this from Team Review to ✅ Done in IDEasy board Apr 2, 2026
@hohwille hohwille deleted the feature/restructure-internal-documentation branch April 2, 2026 06:46
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 internal Nothing to be added to CHANGELOG, only internal story

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

3 participants