Improve documentation formatting and clarity in multiple README.md files (#3979)

Author: Brijeshthummar02

CONTRIBUTING.md

@@ -7,13 +7,15 @@ This document explains how to contribute to this project.
 By contributing you will agree that your contribution will be put under the same license as this repository.
 
 ## Table of Contents
+
 - [Communication](#communication)
 - [Quick start](#quick-start)
 - [Contributor License Agreement (CLA)](#contributor-license-agreement-cla)
 - [Create a fork](#create-a-fork)
 - [Quality](#quality)
 
 ## Communication
+
 For communication please respect our [FOSS Code of Conduct](https://github.com/mercedes-benz/foss/blob/master/CODE_OF_CONDUCT.md).
 
 IMPORTANT: For contributions or issue reports, please start by creating an [issue on Github](https://github.com/mercedes-benz/sechub/issues).
@@ -23,6 +25,7 @@ Thus, all project-related communication should happen here and in English.<br>
 Issue-related communication should happen within the concerned issue.
 
 ## Quick Start
+
 Please look at [First steps Wiki page](https://github.com/mercedes-benz/sechub/wiki/First-steps)
 
 ## Contributor License Agreement (CLA)
@@ -36,6 +39,7 @@ Before you can contribute, you will need to sign our Contributor License Agreeme
 If you are new to contributing in Github, [First Contributions](https://github.com/firstcontributions/first-contributions) might be a good starting point.
 
 ## Create a fork
+
 If you would like to contribute code you can do so through Mercedes-Benz GitHub by forking the repository and sending a pull request.
 
 0. Make sure that an [issue on Github](https://github.com/mercedes-benz/sechub/issues) exists for your contribution
@@ -48,42 +52,50 @@ Inside the description it's a good way to mention the related issues with "close
 It also will close the linked issue automatically when the pull request is merged!
 
 An example pull request description:
+
 ```
 This PR
 - closes #868
 ```
 
 ### Examples for new contributors
+
 - With [feature issue #633](https://github.com/mercedes-benz/sechub/issues/633) all commits are in a dedicated ordering and contain detailed information about the different steps which were necessary.
-- Please look also into the PR description at https://github.com/mercedes-benz/sechub/pull/1029
+- Please look also into the PR description at <https://github.com/mercedes-benz/sechub/pull/1029>
 
 ## Quality
+
 We assume that for every non-trivial contribution, the project has been built and tested prior to the contribution.
 
 ### Documentation
+
 Please ensure that for all contributions, the corresponding documentation is in-sync and up-to-date. All documentation is in English language.
 
 Please see [here](https://mercedes-benz.github.io/sechub/latest/sechub-techdoc.html#section-documentation) for details about documentation.
 
-
 ### Commit messages
+
 GitHub has the possibility to link commits automatically inside issues when mentioned with #${issue number} inside the commit headline.<br>
 To make things easier to follow/maintain, please always provide commit message in following style:
 
 ```
 Dedicated short message what was done #${issue number}
 ```
+
 or
+
 ```
 Dedicated short message what was done #${issue number}
 
 - detail1
 - detail2
 - ...
 ```
+
 NOTE: Here you MUST add an empty second line between headline and details. It's common practice for GIT.
 
 Example:
+
 ```
 Described commit message format #868
 
@@ -92,6 +104,7 @@ Described commit message format #868
 ```
 
 ### Development tools setup
+
 This depends on you which kind of IDE you use for development. But we have some defaults defined - e.g. for git configuration which should be used.
 
 Please check our [development-setup documentation](https://mercedes-benz.github.io/sechub/latest/sechub-techdoc.html#development-setup) for details.

MAINTAINERS.md

@@ -12,7 +12,6 @@
 | Laura Bottner    | <[email protected]>    | [lorriborri](https://github.com/lorriborri)   | Mercedes-Benz Tech Innovation GmbH, [imprint](https://github.com/mercedes-benz/foss/blob/master/PROVIDER_INFORMATION.md) | 2023-09-06 |
 | Hamid Ahmetovic  | <[email protected]>  | [hamidonos](https://github.com/hamidonos)     | Mercedes-Benz Tech Innovation GmbH, [imprint](https://github.com/mercedes-benz/foss/blob/master/PROVIDER_INFORMATION.md) | 2024-06-06 |
 
-
 ## Emeritus Maintainers
 
 | Maintainer        | Email                               | GitHub ID                               | Affiliation                                                                                                       | Joined     | Left       |

SECURITY.md

@@ -2,5 +2,3 @@
 It is Mercedes-Benz’s goal to offer its customers the best and most secure products such as connected cars and other services. Mercedes-Benz values the work of security researchers and whitehat hackers who spend time and effort helping us to achieve this goal.
 
 For further Information please visit our [Vulnerability disclosure program](https://www.mercedes-benz.com/en/whitehat/).
-
-

ide-plugins/eclipse/README.md

@@ -2,6 +2,7 @@
 ![Java build (no eclipse parts)](https://github.com/mercedes-benz/sechub-plugin-eclipse/workflows/Java%20build%20(no%20eclipse%20parts)/badge.svg)
 
 # SecHub Eclipse Plugin
+
 ![SecHub Logo](https://github.com/mercedes-benz/sechub-plugin-eclipse/blob/master/sechub-eclipse-other/images/sechub-logo-big.png)
 
 ## Intended Usage

ide-plugins/jetbrains/README.md

@@ -2,32 +2,39 @@
 ![Java build](https://github.com/mercedes-benz/sechub-plugin-intellij/workflows/Java%20build/badge.svg)
 
 # SecHub IntelliJ Plugin
+
 ![SecHub Logo](https://github.com/mercedes-benz/sechub-plugin-intellij/blob/master/other/images/sechub-logo-big.png)
 
 ## Intended Usage
+
 This is an IntelliJ plugin for a convenient IDE integration of [SecHub](https://github.com/mercedes-benz/sechub)  
 
 Please look at [user guide](src/docs/asciidoc/user-guide.adoc) for more information.
 
-
 ## Installation
+
 You will find the plugin at IntelliJ marketplace when searching for term `sechub`  
 <sup>(it's also listed at https://plugins.jetbrains.com/plugin/23379-sechub).</sup>
 
 ### Stable versions
+
 Simply search for term `sechub` in your marketplace settings and install the latest plugin.
 
 ## Contributing
+
 We welcome any contributions.
 If you want to contribute to this project, please read the [contributing guide](CONTRIBUTING.md).
 
 ## Code of Conduct
+
 Please read our [Code of Conduct](https://github.com/mercedes-benz/foss/blob/master/CODE_OF_CONDUCT.md) as it is our base for interaction.
 
 ## License
+
 This project is licensed under the [MIT LICENSE](LICENSE).
 
 ## Provider Information
+
 Please visit <https://www.mercedes-benz-techinnovation.com/en/imprint/> for information on the provider.
 
 Notice: Before you use the program in productive use, please take all necessary precautions,

ide-plugins/vscode/README.md

@@ -15,7 +15,7 @@ Recommended: Install the plugin from the Open-VSX marketplace from within [VSCod
 
 For VS Code you need to download the [plugin](https://open-vsx.org/extension/mercedes-benz/sechub) and install it manually. It is also possible to install the plugin manually in VSCodium and Eclipse Theia.
 
-NOTE: Please use the new plugin from Mercedes-Benz: https://open-vsx.org/extension/mercedes-benz/sechub. The old Daimler plugin will be deprecated. The reason for the deprecation is the rebranding of Daimler to Mercedes-Benz.
+NOTE: Please use the new plugin from Mercedes-Benz: <https://open-vsx.org/extension/mercedes-benz/sechub>. The old Daimler plugin will be deprecated. The reason for the deprecation is the rebranding of Daimler to Mercedes-Benz.
 
 ## Development
 
@@ -104,4 +104,3 @@ Please visit https://www.mercedes-benz-techinnovation.com/en/imprint/ for inform
 Notice: Before you use the program in productive use, please take all necessary precautions,
 e.g. testing and verifying the program with regard to your specific use.
 The program was tested solely for our own use cases, which might differ from yours.
-

sechub-cli/src/mercedes-benz.com/sechub/cli/testdata/README.md

@@ -2,4 +2,4 @@
 # README.md
 
 This folder is called `testdata` so go will ignore this at build time!
-(this behaviour is used by standard library as well, see https://golang.org/src/cmd/gofmt/testdata/)
+(this behaviour is used by standard library as well, see <https://golang.org/src/cmd/gofmt/testdata/>)

sechub-integrationtest/src/test/resources/checksum-testfiles/README.md

@@ -1,16 +1,19 @@
 <!-- SPDX-License-Identifier: MIT --->
 # About this folder
+
 It will be used for exclude mechanism working on sechub client uploading.
 `sechub-integrationtest-client-sourcescan-exluded_some_files.json`
 does simple exclude this `README.md` and all `exclude-me.txt` files
 
 ## Where is this file used?
+
 See `SecHubExecutionScenarioSecHubClientIntTest.java` and also `sechub-integrationtest-client-sourcescan-excluded_some_files.json`
 
 ## Warning
+
 Please do not change the content of this folder and subfolders because the exclude
 check is done by creating a checksum which is calculated without the excluded files.
 So changing content of included parts will fail test! If you must change the files be aware
 to create a windows and a Linux checksum. Why? Because zip files generated for windows are always
 a little different than on Linux - even when same content. Maybe paths or a hidden OS stamp...
-In order to prevent build and test problems we provide 2 dedicated sha256 keys: one for Windows another for Linux.
+In order to prevent build and test problems we provide 2 dedicated sha256 keys: one for Windows another for Linux.

sechub-pds/src/main/resources/certificates-untracked/README.md

@@ -4,6 +4,7 @@ About p12 folder
 ========================
 
 Here your p12 certificates have to be stored
+
 - local development
 - prod
 - ..
@@ -12,5 +13,3 @@ Inside this folder GIT does ignore anything except this `README.md`!
 
 Why?
 ----
-
-

sechub-server/src/main/resources/certificates-untracked/README.md

@@ -4,6 +4,7 @@ About p12 folder
 ========================
 
 Here your p12 certificates have to be stored
+
 - local development
 - prod
 - ..
@@ -12,5 +13,3 @@ Inside this folder GIT does ignore anything except this `README.md`!
 
 Why?
 ----
-
-