docs: correct the README snippet, the package-count leftovers and the STmin paragraph - #264
Conversation
… STmin paragraph B11: the root README's Subscribe predicate is over CanFrameEvent, not a frame view. B14: SECURITY, CONTRIBUTING (scopes, the Chinese-translation remark), the feature-request template, the migration note and THIRD-PARTY-NOTICES still described four packages or pre-1.3.0 facts. #246: the IsoTp README claimed a measured +-1 ms and a wall-clock test that no longer exists. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
PR SummaryLow Risk Overview The root README “Two minutes” snippet now subscribes with Package count and tooling are updated across SECURITY.md, migration-from-legacy.md, CONTRIBUTING.md (Conventional Commit scopes for The IsoTp README STmin section no longer asserts measured ±1 ms wall-clock accuracy or a CI integration measurement; it states OS scheduling limits, that IsoTpStminTimingTests uses a test-driven clock for logic, and that NFR-003’s accuracy figure is a target. Reviewed by Cursor Bugbot for commit 0ffcf53. Bugbot is set up for automated code reviews on this repo. Configure here. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 09838694ce
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
What does this change?
Documentation fixes from the deep review (§ 3 and § 6 item 5):
view => view.IsExtendedFrame; the predicate is overCanFrameEvent. Nowe => e.Frame.IsExtendedFrame, and the comment describes whatFramesyields.SECURITY.md(four → nine packages),CONTRIBUTING.md(commit scopes for all nine packages; the remark that code carries a Chinese translation, which no file undersrc/ortests/does), the feature-request template (one option per package),docs/migration-from-legacy.md(versions all nine together),THIRD-PARTY-NOTICES.md(polyfills are referenced by six packages, not only RawCan; GitVersion is thegitversion.toollocal tool, notGitVersion.MsBuild).IsoTpStminTimingTestsverifies and that the accuracy is a target.Left alone on purpose: the remaining "four" in the migration and licensing documents refer to the four libraries that came from the legacy fork, which is historical and correct.
Open for the maintainer:
docs/requirements/SRS-CanKit.Pro.mdNFR-003 still demands a ±1 ms accuracy verified by a measured integration test. The suite does not measure it. Rewording the requirement (or adding a measurement) changes what the traceability check holds the code to, so I did not touch it here.Type of change
feat— new behaviour (minor release)fix/perf— bug or performance fix (patch release)docs/test/refactor/chore/ci— no release!in the title, plus aBREAKING CHANGE:footer explaining the migration)Checklist
dotnet build CanKit.Pro.sln -c Releasesucceeds (documentation only, not run)dotnet test CanKit.Pro.sln -c Releasepasses (documentation only, not run)🤖 Generated with Claude Code