Skip to content

Feature/update readme sample#201

Merged
PhenX merged 5 commits intomasterfrom
feature/update-readme-sample
Apr 12, 2026
Merged

Feature/update readme sample#201
PhenX merged 5 commits intomasterfrom
feature/update-readme-sample

Conversation

@PhenX
Copy link
Copy Markdown
Member

@PhenX PhenX commented Apr 12, 2026

No description provided.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the samples/ReadmeSample project into a runnable “feature tour” that demonstrates the full README feature set using a local SQLite database and richer console output.

Changes:

  • Switches the sample to SQLite + Spectre.Console and adds a comprehensive per-feature walkthrough in Program.cs.
  • Expands the sample domain model (status enum, supplier navigation, DTO projection) to cover all documented features.
  • Adds a detailed samples/ReadmeSample/README.md explaining how to run the sample and what each feature does.

Reviewed changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
samples/ReadmeSample/ReadmeSample.csproj Moves the sample to net10.0 and swaps package references to SQLite + Spectre.Console.
samples/ReadmeSample/README.md New end-user documentation for running and understanding the sample.
samples/ReadmeSample/Program.cs Rewrites the entry point into 11 feature demos with SQL + result printing.
samples/ReadmeSample/Extensions/UserExtensions.cs Adds README-aligned [Projectable] extension methods, including overloads.
samples/ReadmeSample/Entities/User.cs Modernizes the entity (file-scoped namespace, required props, init collection).
samples/ReadmeSample/Entities/Supplier.cs Adds optional supplier entity for null-conditional demo.
samples/ReadmeSample/Entities/Product.cs Adds optional supplier navigation + [Projectable] SupplierName.
samples/ReadmeSample/Entities/OrderStatus.cs Adds enum + extension method for enum expansion demo.
samples/ReadmeSample/Entities/OrderItem.cs Cleans up entity + nullability initialization.
samples/ReadmeSample/Entities/Order.cs Adds multiple [Projectable] members covering several features.
samples/ReadmeSample/Dtos/OrderSummaryDto.cs Adds DTO with [Projectable] constructor for projection demo.
samples/ReadmeSample/ConsoleHelper.cs Adds Spectre.Console rendering helpers (SQL highlighting, formatting).
samples/ReadmeSample/ApplicationDbContext.cs Switches to SQLite and configures UseProjectables().
Directory.Packages.props Adds central package version for Spectre.Console.
.gitignore Ignores the generated ReadmeSample.db file.

Comment thread samples/ReadmeSample/ReadmeSample.csproj Outdated
Comment thread samples/ReadmeSample/ApplicationDbContext.cs Outdated
Comment thread samples/ReadmeSample/Entities/Order.cs Outdated
Comment thread samples/ReadmeSample/ConsoleHelper.cs Outdated
Comment thread samples/ReadmeSample/Extensions/UserExtensions.cs
@PhenX PhenX merged commit e4b2c4b into master Apr 12, 2026
4 checks passed
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.

2 participants