Skip to content

Add out-of-support notice pointing to StrongTypes - #178

Merged
patrikmiksovsky95 merged 2 commits into
MewsSystems:masterfrom
KaliCZ:out-of-support-notice
Sep 8, 2026
Merged

patrikmiksovsky95 merged 2 commits into
MewsSystems:masterfrom
KaliCZ:out-of-support-notice

Conversation

@KaliCZ

@KaliCZ KaliCZ commented Sep 8, 2026 •

Copy link
Copy Markdown
Contributor

FuncSharp is out of support, so this adds a warning to the top of the readme saying so and pointing anyone who likes the concepts to StrongTypes, which is where I've been carrying them forward. It also lists a few things that are better there - nullable reference types, pattern matching, generic numeric wrappers, and the JSON / EF Core / OpenAPI integrations. JSON needs no registration there, EF Core and OpenAPI have companion packages, and the notice links their setup docs. Nothing else in the readme changes.

readme.md is packed into the NuGet package, so if another version ever gets published, the notice shows up on nuget.org as well.

I think it'd also make sense to archive the repo and mark the package as deprecated on nuget.org, but that's obviously your call. Happy to reword the support status if you'd put it differently.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

@moxly moxly left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk Assessment

Score: 2/10 — low

The change is documentation-only and does not affect the current library runtime, but one prominent integration claim could mislead users about required package setup.

Review Summary

Verdict: COMMENT
1 warning, 0 nits

The support notice is clear and the linked project's type/API claims check out. The integration wording should distinguish built-in JSON behavior from EF Core and OpenAPI support that requires companion packages and registration.

Fix All — prompt for AI agent

Fix the following issue in this PR:

  1. In readme.md (line 12): replace the “with no extra work” integration claim with accurate wording that explains EF Core and OpenAPI support comes through companion packages and requires their documented setup; keep the no-registration claim limited to the built-in JSON converters.

After all changes, run the project's linter/formatter.


Open this review run in Navigator

Comment thread readme.md Resolved
@moxly moxly added the risk: low label Sep 8, 2026
The notice promised end-to-end support "with no extra work", which only
holds for the JSON converters - those are attached via [JsonConverter].
EF Core and OpenAPI each need a companion package installed and
registered, so name them and link their setup docs instead.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@KaliCZ
KaliCZ marked this pull request as draft September 8, 2026 12:44
@KaliCZ
KaliCZ marked this pull request as ready for review September 8, 2026 12:44

@moxly moxly left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Review Summary

Verdict: APPROVE
Re-review scoped to changes since commit d2432d8 — no new issues; 1 resolved (1 fixed, 0 dismissed), 0 carried forward.


Open this review run in Navigator

@patrikmiksovsky95
patrikmiksovsky95 merged commit 99462f5 into MewsSystems:master Sep 8, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants