Skip to content

docs: correct SDK prerequisite to .NET 10.0+ in README#35

Merged
rubenhensen merged 2 commits into
mainfrom
fix/readme-sdk-version-issue-12
Jun 23, 2026
Merged

docs: correct SDK prerequisite to .NET 10.0+ in README#35
rubenhensen merged 2 commits into
mainfrom
fix/readme-sdk-version-issue-12

Conversation

@dobby-coder

@dobby-coder dobby-coder Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Summary

Closes #12.

The README's Prerequisites section listed .NET 8.0+ SDK, but this understates what's actually required to build the SDK from source.

Verification (against actual .csproj files)

Both project files multi-target net8.0;net10.0:

File TargetFrameworks
src/E4A.PostGuard.csproj net8.0;net10.0
tests/E4A.PostGuard.Tests/E4A.PostGuard.Tests.csproj net8.0;net10.0

Note: the issue body said the project targets net10.0 only — the current .csproj actually multi-targets, so the correct framing is that the SDK must support the highest target (net10.0). A .NET 8 SDK cannot compile the net10.0 target framework. This also matches CI, which installs both 8.0.x and 10.0.x (.github/workflows/build.yml, delivery.yml).

Change

- - .NET 8.0+ SDK
+ - .NET 10.0+ SDK

CHANGELOG.md is auto-generated by release-please and was left untouched. No other docs reference the SDK version.

Testing

dotnet build E4A.PostGuard.slnx with only the .NET 10.0 SDK installed builds both net8.0 and net10.0 targets successfully (0 warnings, 0 errors), confirming the .NET 10.0 SDK is what's needed and sufficient.

🤖 Generated with Claude Code

The README listed '.NET 8.0+ SDK' as a prerequisite, but both
src/E4A.PostGuard.csproj and tests/E4A.PostGuard.Tests.csproj
multi-target net8.0;net10.0. Building the solution requires an SDK
that supports the highest target (net10.0); an 8.0 SDK cannot compile
the net10.0 target. CI installs both 8.0.x and 10.0.x SDKs accordingly.

Fixes #12

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@dobby-coder dobby-coder Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Rules Dobby 2 — rule-compliance pass. Verdict: changes requested (posted as COMMENT since GitHub blocks a formal REQUEST_CHANGES on our own PR). Review findings: 0; rule findings: 1.

The change is accurate and correctly verified. One binding-rule nit: the README now carries a 20-word parenthetical justifying why the net10.0 SDK is required. Per no-justification-paragraphs-for-simple-changes, a self-evident docs fix should just state the prerequisite (- .NET 10.0+ SDK) without narrating the reasoning in user-facing docs. Single inline comment below with a suggestion — please apply it.

Everything else checks out: conventional docs: title, docs-only so no tests needed, README structure intact, PR-body verification was explicitly requested by the issue.

Comment thread README.md Outdated
### Prerequisites

- .NET 8.0+ SDK
- .NET 10.0+ SDK (the projects multi-target `net8.0` and `net10.0`, so the SDK must support the highest target, `net10.0`)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Rule check (no-justification-paragraphs-for-simple-changes): the parenthetical explaining why net10.0 is required is the kind of in-docs editorializing Ruben has asked us to drop for self-evident changes ("Just remove it and let that be that. No need to make a paragraph of text about it."). A reader of Prerequisites just needs the version, and issue #12 itself proposed the terse fix. Suggestion:

Suggested change
- .NET 10.0+ SDK (the projects multi-target `net8.0` and `net10.0`, so the SDK must support the highest target, `net10.0`)
- .NET 10.0+ SDK

The multi-target detail already lives in the .csproj and git history.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@dobby-coder dobby-coder Bot marked this pull request as ready for review June 16, 2026 17:18
@rubenhensen rubenhensen merged commit 3bf4d04 into main Jun 23, 2026
3 checks passed
@rubenhensen rubenhensen deleted the fix/readme-sdk-version-issue-12 branch June 23, 2026 14:06
dobby-coder Bot added a commit to encryption4all/postguard-docs that referenced this pull request Jun 27, 2026
…ard-dotnet#35)

The postguard-dotnet SDK and the pg-dotnet example both multi-target
net8.0;net10.0, so a .NET 10 SDK is required to compile the highest
target. Verified against E4A.PostGuard.csproj and the example's
PostGuard.Example.csproj.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.

README claims '.NET 8.0+ SDK' but project targets net10.0

1 participant