From 32475671b8cb59c3bbf324d702e884d2105bb95e Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 1 Jul 2026 17:08:29 +0000 Subject: [PATCH 1/2] Initial plan From 05f30ebd202774ad3bdec1d22226fa092839532d Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Wed, 1 Jul 2026 17:16:19 +0000 Subject: [PATCH 2/2] feat: rename TemplateDotNetLibrary to Rendering - Rename solution, project folders/files, and test files - Update C# namespaces from TemplateDotNetLibrary to DemaConsulting.Rendering - Rename test class TemplateDotNetLibraryTests to RenderingTests with updated method names - Rename docs directories from template-dot-net-library to rendering - Update all content references in docs, YAML, and markdown files - Update GitHub workflows, issue templates, and CI configuration - All 16 tests pass across .NET 8, 9, and 10 --- .fileassert.yaml | 22 ++++---- .github/ISSUE_TEMPLATE/bug_report.yml | 6 +-- .github/ISSUE_TEMPLATE/config.yml | 6 +-- .github/ISSUE_TEMPLATE/feature_request.yml | 4 +- .github/ISSUE_TEMPLATE/question.yml | 6 +-- .github/codeql-config.yml | 4 +- .github/workflows/build.yaml | 28 +++++------ .reviewmark.yaml | 50 +++++++++---------- CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md | 24 ++++----- README.md | 42 ++++++++-------- Rendering.slnx | 8 +++ SECURITY.md | 20 ++++---- TemplateDotNetLibrary.slnx | 8 --- docs/build_notes/introduction.md | 6 +-- docs/build_notes/title.txt | 6 +-- docs/code_quality/introduction.md | 8 +-- docs/code_quality/title.txt | 6 +-- docs/code_review_plan/introduction.md | 6 +-- docs/code_review_plan/title.txt | 8 +-- docs/code_review_report/introduction.md | 6 +-- docs/code_review_report/title.txt | 8 +-- docs/design/definition.yaml | 4 +- docs/design/introduction.md | 22 ++++---- .../demo.md | 2 +- .../rendering.md} | 4 +- docs/design/title.txt | 6 +-- .../demo.yaml | 0 .../platform-requirements.yaml | 14 +++--- .../rendering.yaml} | 24 ++++----- docs/requirements_doc/introduction.md | 6 +-- docs/requirements_doc/title.txt | 8 +-- docs/requirements_report/introduction.md | 6 +-- docs/requirements_report/title.txt | 8 +-- docs/user_guide/introduction.md | 12 ++--- docs/user_guide/title.txt | 4 +- docs/verification/definition.yaml | 4 +- docs/verification/introduction.md | 14 +++--- .../demo.md | 2 +- .../rendering.md} | 22 ++++---- docs/verification/title.txt | 6 +-- requirements.yaml | 6 +-- .../DemaConsulting.Rendering.csproj} | 16 +++--- .../Demo.cs | 4 +- .../DemaConsulting.Rendering.Tests.csproj} | 2 +- .../DemoTests.cs | 4 +- .../RenderingTests.cs} | 22 ++++---- 47 files changed, 253 insertions(+), 253 deletions(-) create mode 100644 Rendering.slnx delete mode 100644 TemplateDotNetLibrary.slnx rename docs/design/{template-dot-net-library => rendering}/demo.md (95%) rename docs/design/{template-dot-net-library/template-dot-net-library.md => rendering/rendering.md} (95%) rename docs/reqstream/{template-dot-net-library => rendering}/demo.yaml (100%) rename docs/reqstream/{template-dot-net-library => rendering}/platform-requirements.yaml (82%) rename docs/reqstream/{template-dot-net-library/template-dot-net-library.yaml => rendering/rendering.yaml} (78%) rename docs/verification/{template-dot-net-library => rendering}/demo.md (98%) rename docs/verification/{template-dot-net-library/template-dot-net-library.md => rendering/rendering.md} (85%) rename src/{DemaConsulting.TemplateDotNetLibrary/DemaConsulting.TemplateDotNetLibrary.csproj => DemaConsulting.Rendering/DemaConsulting.Rendering.csproj} (85%) rename src/{DemaConsulting.TemplateDotNetLibrary => DemaConsulting.Rendering}/Demo.cs (96%) rename test/{DemaConsulting.TemplateDotNetLibrary.Tests/DemaConsulting.TemplateDotNetLibrary.Tests.csproj => DemaConsulting.Rendering.Tests/DemaConsulting.Rendering.Tests.csproj} (96%) rename test/{DemaConsulting.TemplateDotNetLibrary.Tests => DemaConsulting.Rendering.Tests}/DemoTests.cs (98%) rename test/{DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs => DemaConsulting.Rendering.Tests/RenderingTests.cs} (78%) diff --git a/.fileassert.yaml b/.fileassert.yaml index fe76953..6333ecd 100644 --- a/.fileassert.yaml +++ b/.fileassert.yaml @@ -1,5 +1,5 @@ --- -# FileAssert document validation tests for TemplateDotNetLibrary. +# FileAssert document validation tests for Rendering. # Tests are tagged by document group to allow per-group execution during the build pipeline. # Tags: build-notes, code-quality, code-review, design, verification, user-guide, requirements. # @@ -27,12 +27,12 @@ tests: description: "Build Notes PDF was generated by WeasyPrint" tags: [build-notes] files: - - pattern: "docs/generated/TemplateDotNetLibrary Build Notes.pdf" + - pattern: "docs/generated/Rendering Build Notes.pdf" count: 1 pdf: metadata: - field: "Title" - contains: "Template DotNet Library" + contains: "Rendering" - field: "Author" contains: "DEMA Consulting" - field: "Subject" @@ -60,7 +60,7 @@ tests: description: "Code Quality PDF was generated by WeasyPrint" tags: [code-quality] files: - - pattern: "docs/generated/TemplateDotNetLibrary Code Quality.pdf" + - pattern: "docs/generated/Rendering Code Quality.pdf" count: 1 pdf: metadata: @@ -93,7 +93,7 @@ tests: description: "Code Review Plan PDF was generated by WeasyPrint" tags: [code-review] files: - - pattern: "docs/generated/TemplateDotNetLibrary Review Plan.pdf" + - pattern: "docs/generated/Rendering Review Plan.pdf" count: 1 pdf: metadata: @@ -126,7 +126,7 @@ tests: description: "Code Review Report PDF was generated by WeasyPrint" tags: [code-review] files: - - pattern: "docs/generated/TemplateDotNetLibrary Review Report.pdf" + - pattern: "docs/generated/Rendering Review Report.pdf" count: 1 pdf: metadata: @@ -159,7 +159,7 @@ tests: description: "Design PDF was generated by WeasyPrint" tags: [design] files: - - pattern: "docs/generated/TemplateDotNetLibrary Software Design.pdf" + - pattern: "docs/generated/Rendering Software Design.pdf" count: 1 pdf: metadata: @@ -192,7 +192,7 @@ tests: description: "Verification PDF was generated by WeasyPrint" tags: [verification] files: - - pattern: "docs/generated/TemplateDotNetLibrary Verification Design.pdf" + - pattern: "docs/generated/Rendering Verification Design.pdf" count: 1 pdf: metadata: @@ -225,7 +225,7 @@ tests: description: "User Guide PDF was generated by WeasyPrint" tags: [user-guide] files: - - pattern: "docs/generated/TemplateDotNetLibrary User Guide.pdf" + - pattern: "docs/generated/Rendering User Guide.pdf" count: 1 pdf: metadata: @@ -259,7 +259,7 @@ tests: description: "Requirements PDF was generated by WeasyPrint" tags: [requirements] files: - - pattern: "docs/generated/TemplateDotNetLibrary Requirements.pdf" + - pattern: "docs/generated/Rendering Requirements.pdf" count: 1 pdf: metadata: @@ -293,7 +293,7 @@ tests: description: "Trace Matrix PDF was generated by WeasyPrint" tags: [requirements] files: - - pattern: "docs/generated/TemplateDotNetLibrary Trace Matrix.pdf" + - pattern: "docs/generated/Rendering Trace Matrix.pdf" count: 1 pdf: metadata: diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 720ec1a..95c8173 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,6 @@ --- name: 🐛 Bug Report -description: Report a bug or issue with the TemplateDotNetLibrary +description: Report a bug or issue with the Rendering title: "[Bug]: " labels: ["bug"] assignees: [] @@ -26,7 +26,7 @@ body: label: Steps to Reproduce description: Detailed steps to reproduce the behavior placeholder: | - 1. Use TemplateDotNetLibrary with code '...' + 1. Use Rendering with code '...' 2. Call method '...' 3. Observe error... value: | @@ -69,7 +69,7 @@ body: id: version attributes: label: Library Version - description: What version of the TemplateDotNetLibrary are you using? + description: What version of the Rendering are you using? placeholder: e.g., 1.0.0 validations: required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 337914b..d9033bf 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -2,8 +2,8 @@ blank_issues_enabled: false contact_links: - name: 📚 Documentation - url: https://github.com/demaconsulting/TemplateDotNetLibrary - about: Read the documentation for TemplateDotNetLibrary + url: https://github.com/demaconsulting/Rendering + about: Read the documentation for Rendering - name: 💬 Discussions - url: https://github.com/demaconsulting/TemplateDotNetLibrary/discussions + url: https://github.com/demaconsulting/Rendering/discussions about: Ask questions and discuss with the community diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 468cb28..5097c06 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ --- name: ✨ Feature Request -description: Suggest a new feature or enhancement for the TemplateDotNetLibrary +description: Suggest a new feature or enhancement for the Rendering title: "[Feature]: " labels: ["enhancement"] assignees: [] @@ -52,7 +52,7 @@ body: id: benefits attributes: label: Benefits - description: Explain why this enhancement would be useful to TemplateDotNetLibrary users + description: Explain why this enhancement would be useful to Rendering users placeholder: This would be useful because... validations: required: true diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 4429da5..bdd0299 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,6 +1,6 @@ --- name: ❓ Question / Help -description: Ask a usage question or get help with the TemplateDotNetLibrary +description: Ask a usage question or get help with the Rendering title: "[Question]: " labels: ["question"] assignees: [] @@ -10,7 +10,7 @@ body: value: | Thanks for reaching out! Please fill out the sections below so we can help you as quickly as possible. For general discussion, you can also use - [GitHub Discussions](https://github.com/demaconsulting/TemplateDotNetLibrary/discussions). + [GitHub Discussions](https://github.com/demaconsulting/Rendering/discussions). - type: textarea id: question @@ -45,7 +45,7 @@ body: id: version attributes: label: Library Version - description: What version of the TemplateDotNetLibrary are you using? + description: What version of the Rendering are you using? placeholder: e.g., 1.0.0 validations: required: true diff --git a/.github/codeql-config.yml b/.github/codeql-config.yml index 14509f4..b063b25 100644 --- a/.github/codeql-config.yml +++ b/.github/codeql-config.yml @@ -1,4 +1,4 @@ --- -# CodeQL configuration for Template DotNet Library +# CodeQL configuration for Rendering -name: "Template DotNet Library CodeQL Config" +name: "Rendering CodeQL Config" diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 5ec5c09..abfcc9b 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -168,7 +168,7 @@ jobs: run: > dotnet dotnet-sonarscanner begin - /k:"demaconsulting_TemplateDotNetLibrary" + /k:"demaconsulting_Rendering" /o:"demaconsulting" /d:sonar.token="${{ secrets.SONAR_TOKEN }}" /d:sonar.host.url="https://sonarcloud.io" @@ -223,8 +223,8 @@ jobs: with: name: packages-${{ matrix.os }} path: | - src/DemaConsulting.TemplateDotNetLibrary/bin/Release/*.nupkg - src/DemaConsulting.TemplateDotNetLibrary/bin/Release/*.snupkg + src/DemaConsulting.Rendering/bin/Release/*.nupkg + src/DemaConsulting.Rendering/bin/Release/*.snupkg # Runs CodeQL security and quality analysis, gathering results to include # in the code quality report. @@ -436,7 +436,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/build_notes/generated/build_notes.html - "docs/generated/TemplateDotNetLibrary Build Notes.pdf" + "docs/generated/Rendering Build Notes.pdf" - name: Assert Build Notes Documents with FileAssert run: > @@ -476,7 +476,7 @@ jobs: dotnet sarifmark --sarif artifacts/csharp.sarif --report docs/code_quality/generated/codeql-quality.md - --heading "Template DotNet Library CodeQL Analysis" + --heading "Rendering CodeQL Analysis" --report-depth 1 - name: Display CodeQL Quality Report @@ -492,7 +492,7 @@ jobs: run: > dotnet sonarmark --server https://sonarcloud.io - --project-key demaconsulting_TemplateDotNetLibrary + --project-key demaconsulting_Rendering --branch ${{ github.ref_name }} --token "$SONAR_TOKEN" --report docs/code_quality/generated/sonar-quality.md @@ -519,7 +519,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/code_quality/generated/quality.html - "docs/generated/TemplateDotNetLibrary Code Quality.pdf" + "docs/generated/Rendering Code Quality.pdf" - name: Assert Code Quality Documents with FileAssert run: > @@ -581,7 +581,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/code_review_plan/generated/plan.html - "docs/generated/TemplateDotNetLibrary Review Plan.pdf" + "docs/generated/Rendering Review Plan.pdf" - name: Generate Review Report HTML with Pandoc shell: bash @@ -598,7 +598,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/code_review_report/generated/report.html - "docs/generated/TemplateDotNetLibrary Review Report.pdf" + "docs/generated/Rendering Review Report.pdf" - name: Assert Code Review Documents with FileAssert run: > @@ -630,7 +630,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/design/generated/design.html - "docs/generated/TemplateDotNetLibrary Software Design.pdf" + "docs/generated/Rendering Software Design.pdf" - name: Assert Design Documents with FileAssert run: > @@ -662,7 +662,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/verification/generated/verification.html - "docs/generated/TemplateDotNetLibrary Verification Design.pdf" + "docs/generated/Rendering Verification Design.pdf" - name: Assert Verification Documents with FileAssert run: > @@ -694,7 +694,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/user_guide/generated/user_guide.html - "docs/generated/TemplateDotNetLibrary User Guide.pdf" + "docs/generated/Rendering User Guide.pdf" - name: Assert User Guide Documents with FileAssert run: > @@ -759,7 +759,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/requirements_doc/generated/requirements.html - "docs/generated/TemplateDotNetLibrary Requirements.pdf" + "docs/generated/Rendering Requirements.pdf" - name: Generate Trace Matrix HTML with Pandoc shell: bash @@ -776,7 +776,7 @@ jobs: dotnet weasyprint --pdf-variant pdf/a-3u docs/requirements_report/generated/trace_matrix.html - "docs/generated/TemplateDotNetLibrary Trace Matrix.pdf" + "docs/generated/Rendering Trace Matrix.pdf" - name: Assert Requirements Documents with FileAssert run: > diff --git a/.reviewmark.yaml b/.reviewmark.yaml index 629bd8b..0677c0a 100644 --- a/.reviewmark.yaml +++ b/.reviewmark.yaml @@ -24,7 +24,7 @@ needs-review: # and an index.json before enforcement (--enforce flag) can be enabled in the pipeline. evidence-source: type: url - location: https://raw.githubusercontent.com/demaconsulting/TemplateDotNetLibrary/reviews/index.json + location: https://raw.githubusercontent.com/demaconsulting/Rendering/reviews/index.json # Review sets following hierarchical scope principles. # Each review-set focuses on a single compliance question with manageable file counts. @@ -35,46 +35,46 @@ reviews: paths: - "README.md" - "docs/user_guide/**/*.md" - - "docs/reqstream/template-dot-net-library/template-dot-net-library.yaml" + - "docs/reqstream/rendering/rendering.yaml" - "docs/design/introduction.md" - - "docs/design/template-dot-net-library/template-dot-net-library.md" + - "docs/design/rendering/rendering.md" - # TemplateDotNetLibrary - Specials - - id: TemplateDotNetLibrary-Architecture - title: Review of Template DotNet Library system architecture and operational validation + # Rendering - Specials + - id: Rendering-Architecture + title: Review of Rendering system architecture and operational validation paths: - - "docs/reqstream/template-dot-net-library/template-dot-net-library.yaml" + - "docs/reqstream/rendering/rendering.yaml" - "docs/design/introduction.md" - - "docs/design/template-dot-net-library/template-dot-net-library.md" + - "docs/design/rendering/rendering.md" - "docs/verification/introduction.md" - - "docs/verification/template-dot-net-library/template-dot-net-library.md" - - "test/DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs" + - "docs/verification/rendering/rendering.md" + - "test/DemaConsulting.Rendering.Tests/RenderingTests.cs" - - id: TemplateDotNetLibrary-Design - title: Review of Template DotNet Library architectural and design consistency + - id: Rendering-Design + title: Review of Rendering architectural and design consistency paths: - - "docs/reqstream/template-dot-net-library/template-dot-net-library.yaml" - - "docs/reqstream/template-dot-net-library/platform-requirements.yaml" + - "docs/reqstream/rendering/rendering.yaml" + - "docs/reqstream/rendering/platform-requirements.yaml" - "docs/design/introduction.md" - - "docs/design/template-dot-net-library/**/*.md" + - "docs/design/rendering/**/*.md" - "docs/verification/introduction.md" - - id: TemplateDotNetLibrary-AllRequirements - title: Review of Template DotNet Library requirements quality and traceability + - id: Rendering-AllRequirements + title: Review of Rendering requirements quality and traceability paths: - "requirements.yaml" - - "docs/reqstream/template-dot-net-library/**/*.yaml" + - "docs/reqstream/rendering/**/*.yaml" - "docs/reqstream/ots/*.yaml" - # TemplateDotNetLibrary - Demo - - id: TemplateDotNetLibrary-Demo + # Rendering - Demo + - id: Rendering-Demo title: Review of Demo Unit Implementation paths: - - "docs/reqstream/template-dot-net-library/demo.yaml" - - "docs/design/template-dot-net-library/demo.md" - - "docs/verification/template-dot-net-library/demo.md" - - "src/DemaConsulting.TemplateDotNetLibrary/Demo.cs" - - "test/DemaConsulting.TemplateDotNetLibrary.Tests/DemoTests.cs" + - "docs/reqstream/rendering/demo.yaml" + - "docs/design/rendering/demo.md" + - "docs/verification/rendering/demo.md" + - "src/DemaConsulting.Rendering/Demo.cs" + - "test/DemaConsulting.Rendering.Tests/DemoTests.cs" # OTS Items - id: OTS-BuildMark diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4c5be6d..9834ef5 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -131,4 +131,4 @@ For answers to common questions about this code of conduct, see the FAQ at [Mozilla CoC]: https://github.com/mozilla/diversity [FAQ]: https://www.contributor-covenant.org/faq [translations]: https://www.contributor-covenant.org/translations -[issues]: https://github.com/demaconsulting/TemplateDotNetLibrary/issues +[issues]: https://github.com/demaconsulting/Rendering/issues diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebb38b5..542ab6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contributing to Template DotNet Library +# Contributing to Rendering -Thank you for your interest in contributing to Template DotNet Library! We welcome contributions from the community and +Thank you for your interest in contributing to Rendering! We welcome contributions from the community and appreciate your help in making this project better. ## Code of Conduct @@ -18,7 +18,7 @@ If you find a bug, please create an issue on GitHub with the following informati - **Steps to Reproduce**: Detailed steps to reproduce the issue - **Expected Behavior**: What you expected to happen - **Actual Behavior**: What actually happened -- **Environment**: Operating system, .NET version, Template DotNet Library version +- **Environment**: Operating system, .NET version, Rendering version - **Logs**: Any relevant error messages or logs ### Suggesting Features @@ -56,8 +56,8 @@ We follow a standard GitHub workflow for contributions: 1. Clone the repository: ```bash - git clone https://github.com/demaconsulting/TemplateDotNetLibrary.git - cd TemplateDotNetLibrary + git clone https://github.com/demaconsulting/Rendering.git + cd Rendering ``` 2. Restore dependencies: @@ -260,7 +260,7 @@ When creating a pull request, include: ## Requirements Management -Template DotNet Library uses [DemaConsulting.ReqStream][reqstream] for requirements traceability: +Rendering uses [DemaConsulting.ReqStream][reqstream] for requirements traceability: - All requirements are defined in `requirements.yaml` - Each requirement should be linked to test cases @@ -285,14 +285,14 @@ Releases are managed by project maintainers. The process includes: ## License -By contributing to Template DotNet Library, you agree that your contributions will be licensed under the MIT License. +By contributing to Rendering, you agree that your contributions will be licensed under the MIT License. -Thank you for contributing to Template DotNet Library! +Thank you for contributing to Rendering! -[code-of-conduct]: https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/CODE_OF_CONDUCT.md +[code-of-conduct]: https://github.com/demaconsulting/Rendering/blob/main/CODE_OF_CONDUCT.md [dotnet-download]: https://dotnet.microsoft.com/download [csharp-conventions]: https://learn.microsoft.com/en-us/dotnet/csharp/fundamentals/coding-style/coding-conventions [reqstream]: https://github.com/demaconsulting/ReqStream -[discussions]: https://github.com/demaconsulting/TemplateDotNetLibrary/discussions -[issues]: https://github.com/demaconsulting/TemplateDotNetLibrary/issues -[security]: https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/SECURITY.md +[discussions]: https://github.com/demaconsulting/Rendering/discussions +[issues]: https://github.com/demaconsulting/Rendering/issues +[security]: https://github.com/demaconsulting/Rendering/blob/main/SECURITY.md diff --git a/README.md b/README.md index efff9e5..31f606e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Template DotNet Library +# Rendering [![GitHub forks][badge-forks]][link-forks] [![GitHub stars][badge-stars]][link-stars] @@ -9,7 +9,7 @@ [![Security][badge-security]][link-security] [![NuGet][badge-nuget]][link-nuget] -DEMA Consulting template project for DotNet Libraries, demonstrating best practices for building reusable .NET libraries. +DEMA Consulting rendering library. ## Features @@ -33,13 +33,13 @@ This template demonstrates: Install the library using the .NET CLI: ```bash -dotnet add package TemplateDotNetLibrary +dotnet add package DemaConsulting.Rendering ``` ## Usage ```csharp -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; var demo = new Demo(); var result = demo.DemoMethod("World"); // result = "Hello, World!" @@ -68,23 +68,23 @@ Copyright (c) DEMA Consulting. Licensed under the MIT License. See [LICENSE][lin By contributing to this project, you agree that your contributions will be licensed under the MIT License. -[badge-forks]: https://img.shields.io/github/forks/demaconsulting/TemplateDotNetLibrary?style=plastic -[badge-stars]: https://img.shields.io/github/stars/demaconsulting/TemplateDotNetLibrary?style=plastic -[badge-contributors]: https://img.shields.io/github/contributors/demaconsulting/TemplateDotNetLibrary?style=plastic -[badge-license]: https://img.shields.io/github/license/demaconsulting/TemplateDotNetLibrary?style=plastic -[badge-build]: https://img.shields.io/github/actions/workflow/status/demaconsulting/TemplateDotNetLibrary/build_on_push.yaml?style=plastic -[badge-quality]: https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_TemplateDotNetLibrary&metric=alert_status -[badge-security]: https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_TemplateDotNetLibrary&metric=security_rating -[badge-nuget]: https://img.shields.io/nuget/v/TemplateDotNetLibrary?style=plastic +[badge-forks]: https://img.shields.io/github/forks/demaconsulting/Rendering?style=plastic +[badge-stars]: https://img.shields.io/github/stars/demaconsulting/Rendering?style=plastic +[badge-contributors]: https://img.shields.io/github/contributors/demaconsulting/Rendering?style=plastic +[badge-license]: https://img.shields.io/github/license/demaconsulting/Rendering?style=plastic +[badge-build]: https://img.shields.io/github/actions/workflow/status/demaconsulting/Rendering/build_on_push.yaml?style=plastic +[badge-quality]: https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_Rendering&metric=alert_status +[badge-security]: https://sonarcloud.io/api/project_badges/measure?project=demaconsulting_Rendering&metric=security_rating +[badge-nuget]: https://img.shields.io/nuget/v/DemaConsulting.Rendering?style=plastic -[link-forks]: https://github.com/demaconsulting/TemplateDotNetLibrary/network/members -[link-stars]: https://github.com/demaconsulting/TemplateDotNetLibrary/stargazers -[link-contributors]: https://github.com/demaconsulting/TemplateDotNetLibrary/graphs/contributors -[link-license]: https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/LICENSE -[link-build]: https://github.com/demaconsulting/TemplateDotNetLibrary/actions/workflows/build_on_push.yaml -[link-quality]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetLibrary -[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_TemplateDotNetLibrary -[link-nuget]: https://www.nuget.org/packages/TemplateDotNetLibrary +[link-forks]: https://github.com/demaconsulting/Rendering/network/members +[link-stars]: https://github.com/demaconsulting/Rendering/stargazers +[link-contributors]: https://github.com/demaconsulting/Rendering/graphs/contributors +[link-license]: https://github.com/demaconsulting/Rendering/blob/main/LICENSE +[link-build]: https://github.com/demaconsulting/Rendering/actions/workflows/build_on_push.yaml +[link-quality]: https://sonarcloud.io/dashboard?id=demaconsulting_Rendering +[link-security]: https://sonarcloud.io/dashboard?id=demaconsulting_Rendering +[link-nuget]: https://www.nuget.org/packages/DemaConsulting.Rendering [link-continuous-compliance]: https://github.com/demaconsulting/ContinuousCompliance -[link-contributing]: https://github.com/demaconsulting/TemplateDotNetLibrary/blob/main/CONTRIBUTING.md +[link-contributing]: https://github.com/demaconsulting/Rendering/blob/main/CONTRIBUTING.md diff --git a/Rendering.slnx b/Rendering.slnx new file mode 100644 index 0000000..ff3295e --- /dev/null +++ b/Rendering.slnx @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/SECURITY.md b/SECURITY.md index c356010..73390e9 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ We release patches for security vulnerabilities in the following versions: ## Reporting a Vulnerability -We take the security of Template DotNet Library seriously. If you believe you have found a +We take the security of Rendering seriously. If you believe you have found a security vulnerability, please report it to us as described below. ### How to Report @@ -60,23 +60,23 @@ Security updates will be released as: ## Security Best Practices -When using Template DotNet Library, we recommend following these security best practices: +When using Rendering, we recommend following these security best practices: ### Input Validation - Validate input parameters and data before processing - Be cautious when processing data from untrusted sources -- Use the latest version of Template DotNet Library to benefit from security updates +- Use the latest version of Rendering to benefit from security updates ### Dependencies -- Keep Template DotNet Library and its dependencies up to date +- Keep Rendering and its dependencies up to date - Review the release notes for security-related updates - Use `dotnet list package --vulnerable` to check for vulnerable dependencies ### Usage Environment -- Use Template DotNet Library with the minimum required permissions +- Use Rendering with the minimum required permissions - Validate API tokens and credentials are stored securely - Follow secure coding practices when integrating the library @@ -84,7 +84,7 @@ When using Template DotNet Library, we recommend following these security best p ### Data Handling -Template DotNet Library processes data according to its API. Users should: +Rendering processes data according to its API. Users should: - Validate input data before passing to library functions - Handle sensitive data according to security requirements @@ -107,7 +107,7 @@ We will credit security researchers who report vulnerabilities responsibly. If y ## Third-Party Dependencies -Template DotNet Library relies on third-party packages. We: +Rendering relies on third-party packages. We: - Regularly update dependencies to address known vulnerabilities - Use Dependabot to monitor for security updates @@ -132,9 +132,9 @@ For general bugs and feature requests, please use [GitHub Issues][issues]. - [.NET Security Best Practices][dotnet-security] - [GitHub Security Advisories][security-advisories] -Thank you for helping keep Template DotNet Library and its users safe! +Thank you for helping keep Rendering and its users safe! -[security-advisories]: https://github.com/demaconsulting/TemplateDotNetLibrary/security/advisories -[issues]: https://github.com/demaconsulting/TemplateDotNetLibrary/issues +[security-advisories]: https://github.com/demaconsulting/Rendering/security/advisories +[issues]: https://github.com/demaconsulting/Rendering/issues [owasp-practices]: https://owasp.org/www-project-secure-coding-practices-quick-reference-guide/ [dotnet-security]: https://learn.microsoft.com/en-us/dotnet/standard/security/ diff --git a/TemplateDotNetLibrary.slnx b/TemplateDotNetLibrary.slnx deleted file mode 100644 index a901482..0000000 --- a/TemplateDotNetLibrary.slnx +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/docs/build_notes/introduction.md b/docs/build_notes/introduction.md index 1bfba24..cdbad03 100644 --- a/docs/build_notes/introduction.md +++ b/docs/build_notes/introduction.md @@ -1,11 +1,11 @@ # Introduction -This document contains the build notes for the Template DotNet Library project. +This document contains the build notes for the Rendering project. ## Purpose This report serves as a comprehensive record of changes and bug fixes for this -release of Template DotNet Library. It provides transparency about what has changed since the +release of Rendering. It provides transparency about what has changed since the previous version and helps users understand the improvements and fixes included in this build. @@ -27,7 +27,7 @@ changes and improvements included in this release. This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Users evaluating what has changed in this release - Project stakeholders tracking progress - Contributors understanding recent changes diff --git a/docs/build_notes/title.txt b/docs/build_notes/title.txt index a397ea1..62852c7 100644 --- a/docs/build_notes/title.txt +++ b/docs/build_notes/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library +title: Rendering subtitle: Build Notes author: DEMA Consulting -description: Build notes for the Template DotNet Library reference implementation +description: Build notes for the Rendering reference implementation lang: en-US keywords: - - Template DotNet Library + - Rendering - Build Notes - Release Notes - C# diff --git a/docs/code_quality/introduction.md b/docs/code_quality/introduction.md index c518ea2..2522d1f 100644 --- a/docs/code_quality/introduction.md +++ b/docs/code_quality/introduction.md @@ -1,10 +1,10 @@ # Introduction -This document contains the code quality analysis report for the Template DotNet Library project. +This document contains the code quality analysis report for the Rendering project. ## Purpose -This report provides a comprehensive analysis of the Template DotNet Library codebase including quality gate status, +This report provides a comprehensive analysis of the Rendering codebase including quality gate status, code issues, and security hot-spots. The analysis helps ensure code quality and security standards are maintained throughout development. @@ -21,7 +21,7 @@ This code quality report covers: ## Analysis Source -This report contains quality analysis results captured at the time this version of Template DotNet Library was built. +This report contains quality analysis results captured at the time this version of Rendering was built. It serves as evidence that the code maintains good quality standards and provides transparency about the project's code health. The analysis includes results from various quality tools run during the build process. @@ -29,7 +29,7 @@ project's code health. The analysis includes results from various quality tools This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Quality assurance teams reviewing code quality - Project stakeholders evaluating project health - Contributors understanding quality standards diff --git a/docs/code_quality/title.txt b/docs/code_quality/title.txt index 62f8955..b375d0f 100644 --- a/docs/code_quality/title.txt +++ b/docs/code_quality/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Code Quality Report +title: Rendering Code Quality Report subtitle: Code Quality Analysis Report author: DEMA Consulting -description: Code Quality Analysis Report for Template DotNet Library +description: Code Quality Analysis Report for Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - Code Quality - Analysis - .NET diff --git a/docs/code_review_plan/introduction.md b/docs/code_review_plan/introduction.md index b6d1c2e..2ea409a 100644 --- a/docs/code_review_plan/introduction.md +++ b/docs/code_review_plan/introduction.md @@ -1,11 +1,11 @@ # Introduction -This document contains the review plan for the Template DotNet Library project. +This document contains the review plan for the Rendering project. ## Purpose This review plan provides a comprehensive overview of all files requiring formal review -in the Template DotNet Library project. It identifies which review-sets cover which +in the Rendering project. It identifies which review-sets cover which files and serves as evidence that every file requiring review is covered by at least one named review-set. @@ -27,7 +27,7 @@ that every file requiring review is covered by a current, valid review. This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Quality assurance teams validating review coverage - Project stakeholders reviewing compliance status - Auditors verifying that all required files have been reviewed diff --git a/docs/code_review_plan/title.txt b/docs/code_review_plan/title.txt index 8015e01..eb9e2ad 100644 --- a/docs/code_review_plan/title.txt +++ b/docs/code_review_plan/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Review Plan -subtitle: File Review Plan for the Template DotNet Library +title: Rendering Review Plan +subtitle: File Review Plan for the Rendering author: DEMA Consulting -description: File Review Plan for the Template DotNet Library +description: File Review Plan for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - Review Plan - File Reviews - .NET diff --git a/docs/code_review_report/introduction.md b/docs/code_review_report/introduction.md index 6667592..920580b 100644 --- a/docs/code_review_report/introduction.md +++ b/docs/code_review_report/introduction.md @@ -1,12 +1,12 @@ # Introduction -This document contains the review report for the Template DotNet Library project. +This document contains the review report for the Rendering project. ## Purpose This review report provides evidence that each review-set is current — the review evidence matches the current file fingerprints. It confirms that all formal reviews -conducted for Template DotNet Library remain valid for the current state of the +conducted for Rendering remain valid for the current state of the reviewed files. ## Scope @@ -27,7 +27,7 @@ review-sets are current and no reviewed file has changed since its review was co This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Quality assurance teams validating review currency - Project stakeholders reviewing compliance status - Auditors verifying that all reviews remain valid for the current release diff --git a/docs/code_review_report/title.txt b/docs/code_review_report/title.txt index 64f18b1..069ef81 100644 --- a/docs/code_review_report/title.txt +++ b/docs/code_review_report/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Review Report -subtitle: File Review Report for the Template DotNet Library +title: Rendering Review Report +subtitle: File Review Report for the Rendering author: DEMA Consulting -description: File Review Report for the Template DotNet Library +description: File Review Report for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - Review Report - File Reviews - .NET diff --git a/docs/design/definition.yaml b/docs/design/definition.yaml index 3263656..df844a7 100644 --- a/docs/design/definition.yaml +++ b/docs/design/definition.yaml @@ -5,8 +5,8 @@ resource-path: input-files: - docs/design/title.txt - docs/design/introduction.md - - docs/design/template-dot-net-library/template-dot-net-library.md - - docs/design/template-dot-net-library/demo.md + - docs/design/rendering/rendering.md + - docs/design/rendering/demo.md template: template.html table-of-contents: true number-sections: true diff --git a/docs/design/introduction.md b/docs/design/introduction.md index 2dd07d4..479ff8a 100644 --- a/docs/design/introduction.md +++ b/docs/design/introduction.md @@ -1,12 +1,12 @@ # Introduction -This document provides the detailed design for the Template DotNet Library, a .NET library +This document provides the detailed design for the Rendering, a .NET library demonstrating best practices for DEMA Consulting DotNet Libraries. ## Purpose The purpose of this document is to serve as the design entry point and provide detailed design -specifications for the Template DotNet Library system. This documentation enables formal code +specifications for the Rendering system. This documentation enables formal code review by providing implementation specifications, supports compliance auditing by maintaining clear traceability from requirements through design to code, aids maintenance by documenting system structure and interactions, and ensures quality assurance through detailed technical @@ -21,13 +21,13 @@ This document is intended for: ## Scope -This document covers the detailed design of the Template DotNet Library system and its constituent +This document covers the detailed design of the Rendering system and its constituent software items, specifically: -- **TemplateDotNetLibrary (System)** — The complete .NET library template system +- **Rendering (System)** — The complete .NET library template system - **Demo (Unit)** — Demonstration greeting class providing example functionality -Version applicability: This design applies to all versions of the Template DotNet Library. +Version applicability: This design applies to all versions of the Rendering. The following topics are explicitly excluded from this design documentation: @@ -39,11 +39,11 @@ The following topics are explicitly excluded from this design documentation: ## Software Structure -The following tree diagram shows how the Template DotNet Library software items are organized +The following tree diagram shows how the Rendering software items are organized across System, Subsystem, and Unit levels according to software-items classification standards: ```text -TemplateDotNetLibrary (System) +Rendering (System) └── Demo (Unit) ``` @@ -57,7 +57,7 @@ responsibilities. Each software item has corresponding artifacts in parallel directory trees: ```text -TemplateDotNetLibrary (System) +Rendering (System) └── Demo (Unit) ``` @@ -76,7 +76,7 @@ The source code folder structure mirrors the software structure organization, wi and descriptions as follows: ```text -src/DemaConsulting.TemplateDotNetLibrary/ +src/DemaConsulting.Rendering/ └── Demo.cs — Demonstration greeting class implementing template functionality ``` @@ -96,5 +96,5 @@ Throughout this document: ## References -- [REF-1] Template DotNet Library User Guide () -- [REF-2] Template DotNet Library Repository () +- [REF-1] Rendering User Guide () +- [REF-2] Rendering Repository () diff --git a/docs/design/template-dot-net-library/demo.md b/docs/design/rendering/demo.md similarity index 95% rename from docs/design/template-dot-net-library/demo.md rename to docs/design/rendering/demo.md index e414c2e..a4f1248 100644 --- a/docs/design/template-dot-net-library/demo.md +++ b/docs/design/rendering/demo.md @@ -1,6 +1,6 @@ # Demo -The `Demo` class is the sole software unit in the Template DotNet Library. It serves as a +The `Demo` class is the sole software unit in the Rendering library. It serves as a demonstration of how a DEMA Consulting .NET library class should be structured, documented, and tested. diff --git a/docs/design/template-dot-net-library/template-dot-net-library.md b/docs/design/rendering/rendering.md similarity index 95% rename from docs/design/template-dot-net-library/template-dot-net-library.md rename to docs/design/rendering/rendering.md index aee080b..5c17955 100644 --- a/docs/design/template-dot-net-library/template-dot-net-library.md +++ b/docs/design/rendering/rendering.md @@ -1,10 +1,10 @@ # System Design -This document provides the system-level design for the Template DotNet Library. +This document provides the system-level design for the Rendering. ## System Architecture -The Template DotNet Library is a minimal .NET library template demonstrating DEMA Consulting +The Rendering is a minimal .NET library template demonstrating DEMA Consulting best practices. The system consists of: - **Demo Unit**: Simple greeting functionality demonstrating library patterns diff --git a/docs/design/title.txt b/docs/design/title.txt index 4472a28..781dee9 100644 --- a/docs/design/title.txt +++ b/docs/design/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Software Design Document +title: Rendering Software Design Document subtitle: A .NET Reference Implementation for Libraries author: DEMA Consulting -description: Detailed design document for the Template DotNet Library +description: Detailed design document for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - .NET - Library - Design diff --git a/docs/reqstream/template-dot-net-library/demo.yaml b/docs/reqstream/rendering/demo.yaml similarity index 100% rename from docs/reqstream/template-dot-net-library/demo.yaml rename to docs/reqstream/rendering/demo.yaml diff --git a/docs/reqstream/template-dot-net-library/platform-requirements.yaml b/docs/reqstream/rendering/platform-requirements.yaml similarity index 82% rename from docs/reqstream/template-dot-net-library/platform-requirements.yaml rename to docs/reqstream/rendering/platform-requirements.yaml index 1dcae49..4ea57be 100644 --- a/docs/reqstream/template-dot-net-library/platform-requirements.yaml +++ b/docs/reqstream/rendering/platform-requirements.yaml @@ -26,7 +26,7 @@ sections: DEMA Consulting libraries must support Windows as a major development platform. tests: # Tests link to "windows" to ensure results come from Windows platform - - "windows@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "windows@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-Linux title: The library shall build and run on Linux platforms. @@ -34,7 +34,7 @@ sections: DEMA Consulting libraries must support Linux for CI/CD and containerized environments. tests: # Tests link to "ubuntu" to ensure results come from Linux platform - - "ubuntu@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "ubuntu@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-MacOS title: The library shall build and run on macOS platforms. @@ -42,28 +42,28 @@ sections: DEMA Consulting libraries must support macOS for developers using Apple platforms. tests: # Tests link to "macos" to ensure results come from macOS platform - - "macos@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "macos@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-Net8 title: The library shall support .NET 8 runtime. justification: | .NET 8 is an LTS release providing long-term stability for enterprise users. tests: - - "net8.0@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "net8.0@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-Net9 title: The library shall support .NET 9 runtime. justification: | .NET 9 support enables users to leverage the latest .NET features. tests: - - "net9.0@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "net9.0@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-Net10 title: The library shall support .NET 10 runtime. justification: | .NET 10 support ensures the library remains compatible with the latest .NET ecosystem. tests: - - "net10.0@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "net10.0@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" - id: Template-Platform-NetStd20 title: The library shall support the .NET Standard 2.0 target framework. @@ -75,4 +75,4 @@ sections: Because .NET Framework 4.8.1 implements .NET Standard 2.0, a passing test on net481 demonstrates .NET Standard 2.0 compatibility. tests: - - "net481@TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" + - "net481@Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting" diff --git a/docs/reqstream/template-dot-net-library/template-dot-net-library.yaml b/docs/reqstream/rendering/rendering.yaml similarity index 78% rename from docs/reqstream/template-dot-net-library/template-dot-net-library.yaml rename to docs/reqstream/rendering/rendering.yaml index b0c38f0..a78ebf5 100644 --- a/docs/reqstream/template-dot-net-library/template-dot-net-library.yaml +++ b/docs/reqstream/rendering/rendering.yaml @@ -1,5 +1,5 @@ --- -# Software System Requirements for Template DotNet Library +# Software System Requirements for Rendering # # These requirements describe the externally visible behavior of the library # from the perspective of its consumers, without specifying implementation details. @@ -15,8 +15,8 @@ sections: children: - Template-Demo-Greeting tests: - - TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting - - TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting + - Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting + - Rendering_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting - id: Template-Lib-GreetingFormat title: The library shall return a greeting string in the format "{prefix}, {name}!". @@ -26,8 +26,8 @@ sections: children: - Template-Demo-Greeting tests: - - TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting - - TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting + - Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting + - Rendering_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting - id: Template-Lib-DefaultPrefix title: The library shall use "Hello" as the default greeting prefix. @@ -37,7 +37,7 @@ sections: children: - Template-Demo-DefaultPrefix tests: - - TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting + - Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting - id: Template-Lib-CustomPrefix title: The library shall support a customizable greeting prefix. @@ -49,7 +49,7 @@ sections: - Template-Demo-AcceptCustomPrefix - Template-Demo-Prefix tests: - - TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting + - Rendering_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting - id: Template-Lib-Prefix title: The library shall expose the configured greeting prefix via a read-only property. @@ -59,7 +59,7 @@ sections: children: - Template-Demo-Prefix tests: - - TemplateDotNetLibrary_SystemIntegration_CustomPrefix_ExposesPrefix + - Rendering_SystemIntegration_CustomPrefix_ExposesPrefix - id: Template-Lib-ValidationNull-DemoMethod title: The library shall reject a null name argument to DemoMethod with ArgumentNullException. @@ -70,7 +70,7 @@ sections: children: - Template-Demo-ValidationNull-DemoMethod tests: - - TemplateDotNetLibrary_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException + - Rendering_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException - id: Template-Lib-ValidationNull-Constructor title: The library shall reject a null prefix argument to the constructor with ArgumentNullException. @@ -80,7 +80,7 @@ sections: children: - Template-Demo-ValidationNull-Constructor tests: - - TemplateDotNetLibrary_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException + - Rendering_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException - id: Template-Lib-ValidationEmpty-DemoMethod title: The library shall reject an empty-string name argument to DemoMethod with ArgumentException. @@ -90,7 +90,7 @@ sections: children: - Template-Demo-ValidationEmpty-DemoMethod tests: - - TemplateDotNetLibrary_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException + - Rendering_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException - id: Template-Lib-ValidationEmpty-Constructor title: The library shall reject an empty-string prefix argument to the constructor with ArgumentException. @@ -100,4 +100,4 @@ sections: children: - Template-Demo-ValidationEmpty-Constructor tests: - - TemplateDotNetLibrary_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException + - Rendering_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException diff --git a/docs/requirements_doc/introduction.md b/docs/requirements_doc/introduction.md index 76484a4..f054700 100644 --- a/docs/requirements_doc/introduction.md +++ b/docs/requirements_doc/introduction.md @@ -1,10 +1,10 @@ # Introduction -This document contains the requirements for the Template DotNet Library project. +This document contains the requirements for the Rendering project. ## Purpose -Template DotNet Library is a reference implementation demonstrating best practices for DEMA Consulting +Rendering is a reference implementation demonstrating best practices for DEMA Consulting .NET libraries. It provides a standardized approach to library design, self-validation, and comprehensive documentation generation. @@ -23,7 +23,7 @@ This requirements document covers: This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Quality assurance teams validating requirements - Project stakeholders reviewing project scope - Users understanding the library's capabilities diff --git a/docs/requirements_doc/title.txt b/docs/requirements_doc/title.txt index 668c502..d3341bd 100644 --- a/docs/requirements_doc/title.txt +++ b/docs/requirements_doc/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Requirements -subtitle: Requirements Specification for the Template DotNet Library +title: Rendering Requirements +subtitle: Requirements Specification for the Rendering author: DEMA Consulting -description: Requirements Specification for the Template DotNet Library +description: Requirements Specification for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - Requirements - Specification - .NET diff --git a/docs/requirements_report/introduction.md b/docs/requirements_report/introduction.md index f75c4fc..94b20a3 100644 --- a/docs/requirements_report/introduction.md +++ b/docs/requirements_report/introduction.md @@ -1,12 +1,12 @@ # Introduction -This document contains the requirements traceability matrix for the Template DotNet Library project. +This document contains the requirements traceability matrix for the Rendering project. ## Purpose The trace matrix provides traceability between requirements and test cases, ensuring that all requirements are validated through appropriate testing. This demonstrates that the -Template DotNet Library meets its specified requirements. +Rendering meets its specified requirements. ## Scope @@ -21,7 +21,7 @@ This traceability matrix covers: This document is intended for: -- Software developers working on Template DotNet Library +- Software developers working on Rendering - Quality assurance teams validating requirements coverage - Project stakeholders reviewing test coverage - Auditors verifying requirements traceability diff --git a/docs/requirements_report/title.txt b/docs/requirements_report/title.txt index 7824b8e..b0d7974 100644 --- a/docs/requirements_report/title.txt +++ b/docs/requirements_report/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Trace Matrix -subtitle: Requirements Traceability Matrix for the Template DotNet Library +title: Rendering Trace Matrix +subtitle: Requirements Traceability Matrix for the Rendering author: DEMA Consulting -description: Requirements Traceability Matrix for the Template DotNet Library +description: Requirements Traceability Matrix for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - Trace Matrix - Traceability - Requirements diff --git a/docs/user_guide/introduction.md b/docs/user_guide/introduction.md index c93257b..3223543 100644 --- a/docs/user_guide/introduction.md +++ b/docs/user_guide/introduction.md @@ -2,7 +2,7 @@ ## Purpose -This document is the user guide for the Template DotNet Library, a demonstration project that +This document is the user guide for the Rendering, a demonstration project that showcases best practices for DEMA Consulting DotNet Libraries. ## Scope @@ -33,7 +33,7 @@ compliance evidence is generated automatically on every CI run. Install the library using the .NET CLI: ```bash -dotnet add package TemplateDotNetLibrary +dotnet add package DemaConsulting.Rendering ``` # Usage @@ -41,7 +41,7 @@ dotnet add package TemplateDotNetLibrary ## Basic Usage ```csharp -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; var demo = new Demo(); var result = demo.DemoMethod("World"); @@ -137,7 +137,7 @@ var greeting = demo.DemoMethod("World"); ## Example 1: Basic Greeting ```csharp -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; var demo = new Demo(); var result = demo.DemoMethod("Alice"); @@ -148,7 +148,7 @@ Console.WriteLine(result); ## Example 2: Custom Prefix ```csharp -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; var demo = new Demo("Hi"); var result = demo.DemoMethod("Alice"); @@ -159,7 +159,7 @@ Console.WriteLine(result); ## Example 3: Error Handling ```csharp -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; var demo = new Demo(); try diff --git a/docs/user_guide/title.txt b/docs/user_guide/title.txt index 7fa9528..3066463 100644 --- a/docs/user_guide/title.txt +++ b/docs/user_guide/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library User Guide +title: Rendering User Guide subtitle: A .NET Reference Implementation for Libraries author: DEMA Consulting description: A .NET Reference Implementation for Libraries lang: en-US keywords: - - Template DotNet Library + - Rendering - .NET - Library - Documentation diff --git a/docs/verification/definition.yaml b/docs/verification/definition.yaml index b8b2bff..27fac51 100644 --- a/docs/verification/definition.yaml +++ b/docs/verification/definition.yaml @@ -5,8 +5,8 @@ resource-path: input-files: - docs/verification/title.txt - docs/verification/introduction.md - - docs/verification/template-dot-net-library/template-dot-net-library.md - - docs/verification/template-dot-net-library/demo.md + - docs/verification/rendering/rendering.md + - docs/verification/rendering/demo.md - docs/verification/ots/buildmark.md - docs/verification/ots/fileassert.md - docs/verification/ots/pandoc.md diff --git a/docs/verification/introduction.md b/docs/verification/introduction.md index 4dc8f59..c06817d 100644 --- a/docs/verification/introduction.md +++ b/docs/verification/introduction.md @@ -1,12 +1,12 @@ # Introduction -This document provides the verification design for the Template DotNet Library, a .NET library +This document provides the verification design for the Rendering, a .NET library demonstrating best practices for DEMA Consulting DotNet Libraries. ## Purpose The purpose of this document is to serve as the verification design entry point and document how -requirements will be tested across all software items in the Template DotNet Library system. This +requirements will be tested across all software items in the Rendering system. This documentation enables formal review by mapping every requirement to named test scenarios, supports compliance auditing by providing clear traceability from requirements through verification design to tests, and ensures test completeness can be assessed without reading implementation code. @@ -20,10 +20,10 @@ This document is intended for: ## Scope -This document covers the verification design for the Template DotNet Library system and its +This document covers the verification design for the Rendering system and its constituent software items, specifically: -- **TemplateDotNetLibrary (System)** — The complete .NET library template system +- **Rendering (System)** — The complete .NET library template system - **Demo (Unit)** — Demonstration greeting class providing example functionality The following OTS items are also covered: @@ -54,7 +54,7 @@ The following topics are explicitly excluded from this verification documentatio Each software item in the structure below has corresponding artifacts in parallel directory trees: ```text -TemplateDotNetLibrary (System) +Rendering (System) └── Demo (Unit) OTS Items @@ -87,5 +87,5 @@ Review-sets: defined in `.reviewmark.yaml` ## References -- [REF-1] Template DotNet Library User Guide () -- [REF-2] Template DotNet Library Repository () +- [REF-1] Rendering User Guide () +- [REF-2] Rendering Repository () diff --git a/docs/verification/template-dot-net-library/demo.md b/docs/verification/rendering/demo.md similarity index 98% rename from docs/verification/template-dot-net-library/demo.md rename to docs/verification/rendering/demo.md index 4a722fb..3bd52f0 100644 --- a/docs/verification/template-dot-net-library/demo.md +++ b/docs/verification/rendering/demo.md @@ -9,7 +9,7 @@ in isolation. Because `Demo` has no external dependencies beyond the .NET base c mocking or stubbing is required. Tests supply controlled inputs and assert on returned values and thrown exception types. -Unit tests reside in `DemoTests.cs` within the `DemaConsulting.TemplateDotNetLibrary.Tests` +Unit tests reside in `DemoTests.cs` within the `DemaConsulting.Rendering.Tests` project. ## Test Environment diff --git a/docs/verification/template-dot-net-library/template-dot-net-library.md b/docs/verification/rendering/rendering.md similarity index 85% rename from docs/verification/template-dot-net-library/template-dot-net-library.md rename to docs/verification/rendering/rendering.md index e118a33..18df8f7 100644 --- a/docs/verification/template-dot-net-library/template-dot-net-library.md +++ b/docs/verification/rendering/rendering.md @@ -1,17 +1,17 @@ # System Verification Design -This document describes the system-level verification strategy for the Template DotNet Library. +This document describes the system-level verification strategy for the Rendering. ## Verification Strategy -The Template DotNet Library system is verified through system-level integration tests that +The Rendering system is verified through system-level integration tests that exercise the library as a whole from the perspective of a consumer. Tests instantiate the library using its public API and assert on observable outputs, without relying on knowledge of internal implementation details. No mocking or stubbing is required at the system level — the entire integrated system is exercised as it would be used by a real caller. -System tests reside in `TemplateDotNetLibraryTests.cs` within the -`DemaConsulting.TemplateDotNetLibrary.Tests` project. +System tests reside in `RenderingTests.cs` within the +`DemaConsulting.Rendering.Tests` project. ## Test Environment @@ -30,7 +30,7 @@ with controlled inputs and verify returned values and thrown exceptions. ### Integration: Provides Expected Functionality -**Test**: `TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting` +**Test**: `Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting` Exercises end-to-end system behavior: constructs a `Demo` instance using the default constructor and calls `DemoMethod` with a valid name. Asserts that the system produces the expected greeting @@ -39,7 +39,7 @@ configuration. ### Customization: Handles Configuration Properly -**Test**: `TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting` +**Test**: `Rendering_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting` Verifies that the system correctly propagates a custom prefix supplied at construction time. Constructs a `Demo` instance with prefix `"Welcome"`, calls `DemoMethod` with a valid name, and @@ -48,7 +48,7 @@ integrated components functions as expected. ### Validation: DemoMethod Null Input Throws ArgumentNullException -**Test**: `TemplateDotNetLibrary_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException` +**Test**: `Rendering_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException` Verifies that the system rejects a `null` argument to `DemoMethod` with `ArgumentNullException`. Constructs a `Demo` instance with the default constructor and passes `null` to `DemoMethod`. @@ -56,7 +56,7 @@ Confirms that the system boundary enforces the null-rejection contract. ### Validation: DemoMethod Empty Input Throws ArgumentException -**Test**: `TemplateDotNetLibrary_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException` +**Test**: `Rendering_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException` Verifies that the system rejects an empty-string argument to `DemoMethod` with `ArgumentException`. Constructs a `Demo` instance with the default constructor and passes `string.Empty` to `DemoMethod`. @@ -64,7 +64,7 @@ Confirms that the system boundary enforces the empty-string rejection contract. ### Validation: Constructor Null Prefix Throws ArgumentNullException -**Test**: `TemplateDotNetLibrary_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException` +**Test**: `Rendering_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException` Verifies that the system rejects a `null` prefix argument at construction time with `ArgumentNullException`. Attempts to construct a `Demo` instance with `null` as the prefix. @@ -72,7 +72,7 @@ Confirms that the system boundary prevents invalid configuration from being esta ### Validation: Constructor Empty Prefix Throws ArgumentException -**Test**: `TemplateDotNetLibrary_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException` +**Test**: `Rendering_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException` Verifies that the system rejects an empty-string prefix argument at construction time with `ArgumentException`. Attempts to construct a `Demo` instance with `string.Empty` as the prefix. @@ -80,7 +80,7 @@ Confirms that the system boundary prevents empty-string configuration from being ### Integration: Exposes Configured Prefix -**Test**: `TemplateDotNetLibrary_SystemIntegration_CustomPrefix_ExposesPrefix` +**Test**: `Rendering_SystemIntegration_CustomPrefix_ExposesPrefix` Verifies that the `Prefix` property exposes the prefix supplied at construction time. Constructs a `Demo` instance with a custom prefix and reads the `Prefix` property. Confirms the system's diff --git a/docs/verification/title.txt b/docs/verification/title.txt index a5796be..ad3b9cc 100644 --- a/docs/verification/title.txt +++ b/docs/verification/title.txt @@ -1,11 +1,11 @@ --- -title: Template DotNet Library Verification Design Document +title: Rendering Verification Design Document subtitle: A .NET Reference Implementation for Libraries author: DEMA Consulting -description: Verification design document for the Template DotNet Library +description: Verification design document for the Rendering lang: en-US keywords: - - Template DotNet Library + - Rendering - .NET - Library - Verification diff --git a/requirements.yaml b/requirements.yaml index eddf147..2d1d374 100644 --- a/requirements.yaml +++ b/requirements.yaml @@ -1,9 +1,9 @@ --- # Root requirements file - includes all system, unit, platform, and OTS requirements includes: - - docs/reqstream/template-dot-net-library/template-dot-net-library.yaml - - docs/reqstream/template-dot-net-library/demo.yaml - - docs/reqstream/template-dot-net-library/platform-requirements.yaml + - docs/reqstream/rendering/rendering.yaml + - docs/reqstream/rendering/demo.yaml + - docs/reqstream/rendering/platform-requirements.yaml - docs/reqstream/ots/xunit.yaml - docs/reqstream/ots/reqstream.yaml - docs/reqstream/ots/buildmark.yaml diff --git a/src/DemaConsulting.TemplateDotNetLibrary/DemaConsulting.TemplateDotNetLibrary.csproj b/src/DemaConsulting.Rendering/DemaConsulting.Rendering.csproj similarity index 85% rename from src/DemaConsulting.TemplateDotNetLibrary/DemaConsulting.TemplateDotNetLibrary.csproj rename to src/DemaConsulting.Rendering/DemaConsulting.Rendering.csproj index 1bcf106..6c36dd9 100644 --- a/src/DemaConsulting.TemplateDotNetLibrary/DemaConsulting.TemplateDotNetLibrary.csproj +++ b/src/DemaConsulting.Rendering/DemaConsulting.Rendering.csproj @@ -7,20 +7,20 @@ enable - TemplateDotNetLibrary + DemaConsulting.Rendering 0.0.0 DEMA Consulting DEMA Consulting - Template project for DEMA Consulting DotNet Libraries + Rendering library for DEMA Consulting MIT - https://github.com/demaconsulting/TemplateDotNetLibrary - https://github.com/demaconsulting/TemplateDotNetLibrary + https://github.com/demaconsulting/Rendering + https://github.com/demaconsulting/Rendering README.md Icon.png - template;dotnet-library + rendering;dotnet-library Copyright DEMA Consulting - Template DotNet Library - TemplateDotNetLibrary + Rendering + Rendering true @@ -71,7 +71,7 @@ - + diff --git a/src/DemaConsulting.TemplateDotNetLibrary/Demo.cs b/src/DemaConsulting.Rendering/Demo.cs similarity index 96% rename from src/DemaConsulting.TemplateDotNetLibrary/Demo.cs rename to src/DemaConsulting.Rendering/Demo.cs index 4ddf13f..7bef8da 100644 --- a/src/DemaConsulting.TemplateDotNetLibrary/Demo.cs +++ b/src/DemaConsulting.Rendering/Demo.cs @@ -1,10 +1,10 @@ -namespace TemplateDotNetLibrary; +namespace DemaConsulting.Rendering; /// /// Demonstration class for the template library. /// /// -/// This class serves as the sole software unit in the Template DotNet Library, +/// This class serves as the sole software unit in the Rendering library, /// demonstrating DEMA Consulting patterns for structure, documentation, and testing. /// Instances are immutable after construction and are therefore thread-safe. /// diff --git a/test/DemaConsulting.TemplateDotNetLibrary.Tests/DemaConsulting.TemplateDotNetLibrary.Tests.csproj b/test/DemaConsulting.Rendering.Tests/DemaConsulting.Rendering.Tests.csproj similarity index 96% rename from test/DemaConsulting.TemplateDotNetLibrary.Tests/DemaConsulting.TemplateDotNetLibrary.Tests.csproj rename to test/DemaConsulting.Rendering.Tests/DemaConsulting.Rendering.Tests.csproj index c8627e7..01af3fe 100644 --- a/test/DemaConsulting.TemplateDotNetLibrary.Tests/DemaConsulting.TemplateDotNetLibrary.Tests.csproj +++ b/test/DemaConsulting.Rendering.Tests/DemaConsulting.Rendering.Tests.csproj @@ -60,7 +60,7 @@ - + diff --git a/test/DemaConsulting.TemplateDotNetLibrary.Tests/DemoTests.cs b/test/DemaConsulting.Rendering.Tests/DemoTests.cs similarity index 98% rename from test/DemaConsulting.TemplateDotNetLibrary.Tests/DemoTests.cs rename to test/DemaConsulting.Rendering.Tests/DemoTests.cs index fa30590..afd2247 100644 --- a/test/DemaConsulting.TemplateDotNetLibrary.Tests/DemoTests.cs +++ b/test/DemaConsulting.Rendering.Tests/DemoTests.cs @@ -1,6 +1,6 @@ -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; -namespace DemaConsulting.TemplateDotNetLibrary.Tests; +namespace DemaConsulting.Rendering.Tests; /// /// Unit tests for the Demo class. diff --git a/test/DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs b/test/DemaConsulting.Rendering.Tests/RenderingTests.cs similarity index 78% rename from test/DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs rename to test/DemaConsulting.Rendering.Tests/RenderingTests.cs index 2c845d4..50a3f73 100644 --- a/test/DemaConsulting.TemplateDotNetLibrary.Tests/TemplateDotNetLibraryTests.cs +++ b/test/DemaConsulting.Rendering.Tests/RenderingTests.cs @@ -1,18 +1,18 @@ -using TemplateDotNetLibrary; +using DemaConsulting.Rendering; -namespace DemaConsulting.TemplateDotNetLibrary.Tests; +namespace DemaConsulting.Rendering.Tests; /// -/// System-level integration tests for the TemplateDotNetLibrary system. +/// System-level integration tests for the Rendering system. /// -public class TemplateDotNetLibraryTests +public class RenderingTests { /// /// Proves that the system can be instantiated and provides expected functionality /// when integrated with all components. /// [Fact] - public void TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting() + public void Rendering_SystemIntegration_DefaultConstruction_ReturnsExpectedGreeting() { // Arrange: set up system-level integration test var demo = new Demo(); @@ -30,7 +30,7 @@ public void TemplateDotNetLibrary_SystemIntegration_DefaultConstruction_ReturnsE /// across all integrated components. /// [Fact] - public void TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting() + public void Rendering_SystemCustomization_CustomPrefix_ReturnsExpectedGreeting() { // Arrange: set up system with custom configuration const string customPrefix = "Welcome"; @@ -49,7 +49,7 @@ public void TemplateDotNetLibrary_SystemCustomization_CustomPrefix_ReturnsExpect /// with the expected exception at the system level. /// [Fact] - public void TemplateDotNetLibrary_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException() + public void Rendering_SystemValidation_DemoMethodNullInput_ThrowsArgumentNullException() { // Arrange: set up system components var demo = new Demo(); @@ -63,7 +63,7 @@ public void TemplateDotNetLibrary_SystemValidation_DemoMethodNullInput_ThrowsArg /// with the expected exception at the system level. /// [Fact] - public void TemplateDotNetLibrary_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException() + public void Rendering_SystemValidation_DemoMethodEmptyInput_ThrowsArgumentException() { // Arrange: set up system components var demo = new Demo(); @@ -77,7 +77,7 @@ public void TemplateDotNetLibrary_SystemValidation_DemoMethodEmptyInput_ThrowsAr /// with the expected exception at the system level. /// [Fact] - public void TemplateDotNetLibrary_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException() + public void Rendering_SystemValidation_ConstructorNullPrefix_ThrowsArgumentNullException() { // Act & Assert: system validates constructor null prefix properly Assert.Throws(() => new Demo(null!)); @@ -88,7 +88,7 @@ public void TemplateDotNetLibrary_SystemValidation_ConstructorNullPrefix_ThrowsA /// with the expected exception at the system level. /// [Fact] - public void TemplateDotNetLibrary_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException() + public void Rendering_SystemValidation_ConstructorEmptyPrefix_ThrowsArgumentException() { // Act & Assert: system validates constructor empty prefix properly Assert.Throws(() => new Demo(string.Empty)); @@ -98,7 +98,7 @@ public void TemplateDotNetLibrary_SystemValidation_ConstructorEmptyPrefix_Throws /// Proves that the Prefix property exposes the configured prefix at the system level. /// [Fact] - public void TemplateDotNetLibrary_SystemIntegration_CustomPrefix_ExposesPrefix() + public void Rendering_SystemIntegration_CustomPrefix_ExposesPrefix() { // Arrange: construct system with a custom prefix const string customPrefix = "Greetings";