[#4] Introduce developer guide with log documentation

[elfenpiff]

Notes for Reviewer

A detailed documentation about logging (and also how to handle errors since they are tightly coupled to logging) in iceoryx2.

Pre-Review Checklist for the PR Author

1. [x] Add sensible notes for the reviewer
2. [x] PR title is short, expressive and meaningful
3. [x] Relevant issues are linked in the References section
4. [x] Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. [x] Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. [x] Commits messages are according to this guideline
   • [x] Commit messages have the issue ID ([#123] Add posix ipc example)
   • [x] Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. [x] Tests follow the best practice for testing
8. [x] Changelog updated in the unreleased section including API breaking changes
9. [x] Assign PR to reviewer
10. [x] All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

• [x] Commits are properly organized and messages are according to the guideline
• [x] Unit tests have been written for new behavior
• [x] Public API is documented
• [x] PR title describes the changes

Post-review Checklist for the PR Author

1. [ ] All open points are addressed and tracked via issues

References

Relates to #4

[codecov[bot]]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 78.95%. Comparing base (e5b44a9) to head (3f4dd87). Report is 7 commits behind head on main.

Additional details and impacted files

[](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/469?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx) ```diff @@ Coverage Diff @@ ## main #469 +/- ## ========================================== - Coverage 79.08% 78.95% -0.13% ========================================== Files 196 197 +1 Lines 23572 23637 +65 ========================================== + Hits 18641 18663 +22 - Misses 4931 4974 +43 ``` [see 5 files with indirect coverage changes](https://app.codecov.io/gh/eclipse-iceoryx/iceoryx2/pull/469/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=eclipse-iceoryx)