docs: update README and CHANGELOG to reflect v0.0.2 state#17
Conversation
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📝 WalkthroughWalkthroughUpdated 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
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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.
ab61c5d to
1fa20ce
Compare
There was a problem hiding this comment.
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
1fa20ce to
516962b
Compare
- 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
Chores