Skip to content

docs: update README and CHANGELOG to reflect v0.0.2 state#17

Merged
vtz merged 1 commit intomainfrom
fix/outdated-documentation
Feb 22, 2026
Merged

docs: update README and CHANGELOG to reflect v0.0.2 state#17
vtz merged 1 commit intomainfrom
fix/outdated-documentation

Conversation

@vtz
Copy link
Owner

@vtz vtz commented Feb 22, 2026

  • Fix version from 0.0.1 to 0.0.2
  • Update test count from 62+ to 169 C++ / 80+ Python
  • Add E2E Protection, configurable UDP to Core Features
  • Rewrite Project Structure tree to match actual filesystem
  • Expand Architecture section with all 8 library modules
  • Merge duplicated Development Status sections
  • Add mentions of Docker, pre-commit, Sphinx-Needs, cross-platform demo
  • Remove Windows/MSVC from prerequisites (CI dropped)
  • Fix test execution paths (./bin/test_*)
  • Fix CHANGELOG URLs from placeholder to vtz/opensomeip

Summary by CodeRabbit

  • Documentation

    • README updated to v0.0.2 with expanded architecture, modular layer descriptions, examples, and testing metrics
    • Added IPv4 Service Discovery, configurable UDP transport options, E2E Protection, and expanded build/dev tooling notes
  • Chores

    • Updated CHANGELOG repository links to reflect new repository location

@coderabbitai
Copy link

coderabbitai bot commented Feb 22, 2026

Warning

Rate limit exceeded

@vtz has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 8 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

Updated release links in CHANGELOG.md and substantially expanded README.md: version bumped to 0.0.2, new/clarified feature descriptions (IPv4 Service Discovery, UDP transport options, E2E Protection), reorganized modular architecture and project layout, and updated development/testing guidance.

Changes

Cohort / File(s) Summary
Release Anchor Links
CHANGELOG.md
Repointed release repository links from https://github.com/your-org/some-ip to https://github.com/vtz/opensomeip for releases 0.0.2 and 0.0.1.
Primary Documentation
README.md
Large expansion and reorganization: version bumped 0.0.1 → 0.0.2; added IPv4 Service Discovery note, UDP transport config (blocking/non-blocking, buffer sizes), and End-to-End Protection; numerous architectural and wording updates.
Prereqs & Tooling
README.md
Removed MSVC-specific prerequisite in favor of general C++17/modern toolchain; added pre-commit hooks, Docker testing note, and clarified Google Test auto-download requirement.
Architecture & Project Layout
README.md
Renamed/core layer and introduced modular layers (Service Discovery, Transport Protocol, RPC, Events, someip-core, etc.); reorganized include/ and src/ into per-layer subdirectories and expanded examples/tests/scripts/docs directories.
Testing & Metrics
README.md
Updated test counts and execution notes (169 C++ unit tests, 80+ Python tests), described new test binary layout (bin/test_*) and CI/test scripts.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through lines and links anew,
Docs stretched wider, tidy as dew,
IPv4, UDP, protection in tow,
Tests a-rising, steady they grow,
0.0.2 — a carrot-glow! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: updating documentation (README and CHANGELOG) to reflect the v0.0.2 release state, which aligns with all the file modifications described.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/outdated-documentation

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 510-511: The markdown heading "### Current Test Coverage (169 C++
unit tests + 80+ Python tests)" is missing a blank line before the following
bullet, triggering MD022; fix it by inserting a single blank line immediately
after the "### Current Test Coverage (169 C++ unit tests + 80+ Python tests)"
heading so the subsequent list ("- Message serialization/deserialization") is
separated from the heading.
- Line 502: Replace the misleading range "AUTOSAR P01-P11" in the line
containing "Advanced E2E profiles (AUTOSAR P01-P11) - requires external
implementation due to licensing" with the explicit profile list that matches the
E2E Protection Disclaimer: "AUTOSAR P01, P02, P04, P05, P06, P07, P11" so the
README text and the disclaimer are consistent.
- Around line 273-307: Add a single blank line after each of the top-level
section headings to satisfy MD022: insert an empty line immediately after "Core
Layer (`someip-core`)", "Serialization Layer (`someip-serialization`)",
"Transport Layer (`someip-transport`)", "Service Discovery Layer (`someip-sd`)",
and "Transport Protocol Layer (`someip-tp`)" (and similarly for "RPC Layer
(`someip-rpc`)" and "Events Layer (`someip-events`) if present) so each heading
is followed by one blank line before the list content.

@vtz vtz force-pushed the fix/outdated-documentation branch 2 times, most recently from ab61c5d to 1fa20ce Compare February 22, 2026 00:39
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CHANGELOG.md`:
- Around line 93-94: The CHANGELOG.md references non-existent release tags
v0.0.1 and v0.0.2 which will 404; either create and push annotated Git tags
named v0.0.1 and v0.0.2 to the repository (so the links in CHANGELOG.md resolve)
or remove/replace the two link references for [0.0.2] and [0.0.1] in
CHANGELOG.md; locate the entries by the tag names v0.0.1 and v0.0.2 and update
the file accordingly.

In `@README.md`:
- Line 63: Update the phrase "C++17 compatible compiler (GCC 9+, Clang 10+)" to
use the compound modifier form by inserting a hyphen: change it to
"C++17-compatible compiler (GCC 9+, Clang 10+)" so the README's requirement is
grammatically correct.
- Around line 283-288: The README's Architecture section incorrectly embeds E2E
under "Core Layer" while the codebase and CMakeLists.txt define e2e as its own
module (look for e2e/, E2E_SOURCES and the module list: core, e2e,
serialization, transport, rpc, sd, events, tp); update the README by removing
the "E2E protection" bullet from the Core Layer list and add a new dedicated
"E2E Layer (`someip-e2e`)" section after the Core Layer that summarizes its
responsibilities (directory layout, E2E_SOURCES, CRC/header/profile registry) so
the documentation matches the modular structure.

---

Duplicate comments:
In `@README.md`:
- Line 523: The README's phrase "Advanced E2E profiles (AUTOSAR P01-P11)"
incorrectly implies a continuous range and conflicts with the E2E disclaimer
which only lists "P01, P02, P04, P05, P06, P07, P11"; update the text to match
the disclaimer by replacing the range with the explicit profile list (e.g.,
"Advanced E2E profiles (AUTOSAR P01, P02, P04, P05, P06, P07, P11)") or
alternatively update the E2E disclaimer to include the omitted profiles if the
intent is to cover P03, P08, P09, and P10 — ensure the two places use the same
explicit identifiers so they remain consistent.

- Fix version from 0.0.1 to 0.0.2
- Update test count from 62+ to 169 C++ / 80+ Python
- Add E2E Protection, configurable UDP to Core Features
- Rewrite Project Structure tree to match actual filesystem
- Expand Architecture section with all 8 library modules
- Merge duplicated Development Status sections
- Add mentions of Docker, pre-commit, Sphinx-Needs, cross-platform demo
- Remove Windows/MSVC from prerequisites (CI dropped)
- Fix test execution paths (./bin/test_*)
- Fix CHANGELOG URLs from placeholder to vtz/opensomeip
@vtz vtz force-pushed the fix/outdated-documentation branch from 1fa20ce to 516962b Compare February 22, 2026 00:47
@vtz vtz merged commit da3b25f into main Feb 22, 2026
4 checks passed
@vtz vtz deleted the fix/outdated-documentation branch February 22, 2026 02:21
vtz added a commit that referenced this pull request Feb 24, 2026
- Fix version from 0.0.1 to 0.0.2
- Update test count from 62+ to 169 C++ / 80+ Python
- Add E2E Protection, configurable UDP to Core Features
- Rewrite Project Structure tree to match actual filesystem
- Expand Architecture section with all 8 library modules
- Merge duplicated Development Status sections
- Add mentions of Docker, pre-commit, Sphinx-Needs, cross-platform demo
- Remove Windows/MSVC from prerequisites (CI dropped)
- Fix test execution paths (./bin/test_*)
- Fix CHANGELOG URLs from placeholder to vtz/opensomeip
@coderabbitai coderabbitai bot mentioned this pull request Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant