Adding inital coding guidelines doc

[MaciejKaszynski]

Adding some rules for our code we have in the repo to make sure our code is clean and standardized.

Fixes #423

[github-actions]

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 0b960798-1b2a-445d-a0e5-803403a77656
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (41 packages loaded, 10 targets configured)

Analyzing: target //:license-check (89 packages loaded, 10 targets configured)

Analyzing: target //:license-check (112 packages loaded, 1753 targets configured)

Analyzing: target //:license-check (159 packages loaded, 5715 targets configured)

Analyzing: target //:license-check (170 packages loaded, 9430 targets configured)

Analyzing: target //:license-check (172 packages loaded, 9451 targets configured)

Analyzing: target //:license-check (173 packages loaded, 9575 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11589 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 23.457s, Critical Path: 0.37s
INFO: 16 processes: 4 disk cache hit, 12 internal.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

[danth]

It would be nice to add a short explanation why these were chosen (or link to an article).

For example

• https://gist.github.com/Eisenwave/5cca27867828743bf50ad95d526f5a6e
• https://en.wikipedia.org/wiki/Yoda_conditions#Criticism

[NicolasFussberger]

Some ideas for extension:

• what namespace to use where
• designing classes for testability, encourage dependency injection and discourage using linker-based replacement or header redirect or something like that
• Usage of OSAL classes, encourage using the baselibs OSAL classes, discourage adding custom OSAL class
• Maybe folder structure & bazel visibility, everything within "details" is private to this (sub) component and shall not be accessible outside. Everything in "src" is the component API

[NicolasFussberger]

maybe to add naming convention for mocks, naming convention for pure virtual interfaces

[NicolasFussberger]

Use RAII patterns for resource management