Skip to content

Ship a starter README in generated solutions - #64

Merged
stphnwlsh merged 4 commits into
mainfrom
feature/starter-readme
Nov 8, 2026
Merged

stphnwlsh merged 4 commits into
mainfrom
feature/starter-readme

Conversation

@stphnwlsh

@stphnwlsh stphnwlsh commented Nov 7, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

A generated solution had no README.md at its root, because the template's own README stays out of the package. Each template now ships a short starter README as template/README.md, packed as the solution's README.md. It names the solution, shows how to build, test and run it, and links docs/RUN.md, AGENTS.md and the template's docs.

Related issues

Part of LeanMeanCleanApps/.github#79

Type of change

  • Bug fix
  • New feature
  • Breaking change (the generated solution or template parameters change in a way existing users will notice)
  • Refactoring or clean-up
  • Documentation
  • Build, pipeline or dependency update

Shared layers

  • This only touches the Presentation layer of this template.
  • This touches the Application or Infrastructure layers, tests, pipeline or repository setup, so it needs to be carried across all five templates.

Checklist

  • dotnet build and dotnet test pass locally with no warnings.
  • I added or updated tests, and line coverage stays at or above 95%.
  • I updated the README or docs where behaviour changed.
  • If this changes how we do something, I updated the matching skill in .agents/skills.
  • I checked the template still installs and creates a working solution (see CONTRIBUTING.md).

@stphnwlsh stphnwlsh self-assigned this Nov 7, 2026
@github-actions github-actions Bot added enhancement New feature or request build labels Nov 7, 2026
@github-actions

github-actions Bot commented Nov 7, 2026 •

Copy link
Copy Markdown
Contributor

Build Pipeline

✅ Ready to merge. Every stage passed.

Stage Result Details
Build 🟢 Passed Version 2026.11.08.232-pr-64 · Template package 250 KB
Test 🟢 Passed 304 passed · 0 failed · 0 skipped · Template installs, builds and passes its tests
Coverage 🟢 Passed 100% (1119 of 1119 lines) · Needs 95%
Static Analysis 🟢 Passed No open CodeQL alerts
Dependency Review 🟢 Passed 0 vulnerable packages · 0 licence problems
Container Scan 🟢 Passed Image starts and answers · 1 open Trivy alert, none blocking: 1 medium

Commit 19ac1c2 · Full run

@stphnwlsh
stphnwlsh merged commit 6087806 into main Nov 8, 2026
13 checks passed
@stphnwlsh
stphnwlsh deleted the feature/starter-readme branch November 8, 2026 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant