Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,13 @@
"SonarQube",
"spdx",
"streetsidesoftware",
"templatetool",
"empira",
"fileshare",
"PdfSharp",
"reindex",
"reviewmark",
"ReviewMark",
"testname",
"TMPL",
"tracematrix",
"triaging",
"Trivy",
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 🐛 Bug Report
description: Report a bug or issue with the TemplateDotNetTool
description: Report a bug or issue with the ReviewMark
title: "[Bug]: "
labels: ["bug"]
assignees: []
Expand All @@ -26,7 +26,7 @@ body:
label: Steps to Reproduce
description: Detailed steps to reproduce the behavior
placeholder: |
1. Run TemplateDotNetTool with command '...'
1. Run ReviewMark with command '...'
2. Provide input file '...'
3. Observe error...
value: |
Expand Down Expand Up @@ -69,7 +69,7 @@ body:
id: version
attributes:
label: Tool Version
description: What version of the TemplateDotNetTool are you using?
description: What version of the ReviewMark are you using?
placeholder: e.g., 1.0.0
validations:
required: true
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
blank_issues_enabled: false
contact_links:
- name: 📚 Documentation
url: https://github.com/demaconsulting/TemplateDotNetTool
about: Read the documentation for TemplateDotNetTool
url: https://github.com/demaconsulting/ReviewMark
about: Read the documentation for ReviewMark
- name: 💬 Discussions
url: https://github.com/demaconsulting/TemplateDotNetTool/discussions
url: https://github.com/demaconsulting/ReviewMark/discussions
about: Ask questions and discuss with the community
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ✨ Feature Request
description: Suggest a new feature or enhancement for the TemplateDotNetTool
description: Suggest a new feature or enhancement for the ReviewMark
title: "[Feature]: "
labels: ["enhancement"]
assignees: []
Expand Down Expand Up @@ -43,15 +43,15 @@ body:
placeholder: |
```csharp
// Example usage
templatetool --input report.json --output report.md --feature-flag
reviewmark --input report.json --output report.md --feature-flag
```
render: csharp

- type: textarea
id: benefits
attributes:
label: Benefits
description: Explain why this enhancement would be useful to TemplateDotNetTool users
description: Explain why this enhancement would be useful to ReviewMark users
placeholder: This would be useful because...
validations:
required: true
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: ❓ Question / Help
description: Ask a usage question or get help with the TemplateDotNetTool
description: Ask a usage question or get help with the ReviewMark
title: "[Question]: "
labels: ["question"]
assignees: []
Expand All @@ -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/TemplateDotNetTool/discussions).
[GitHub Discussions](https://github.com/demaconsulting/ReviewMark/discussions).

- type: textarea
id: question
Expand Down Expand Up @@ -45,7 +45,7 @@ body:
id: version
attributes:
label: Tool Version
description: What version of the TemplateDotNetTool are you using?
description: What version of the ReviewMark are you using?
placeholder: e.g., 1.0.0
validations:
required: true
Expand Down
10 changes: 5 additions & 5 deletions .github/codeql-config.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
# CodeQL configuration for Template DotNet Tool
# CodeQL configuration for ReviewMark
# Suppresses intentional generic catch clauses

name: "Template DotNet Tool CodeQL Config"
name: "ReviewMark CodeQL Config"

# Query filters to disable specific queries for certain paths
query-filters:
- exclude:
id: cs/catch-of-all-exceptions
paths:
- src/DemaConsulting.TemplateDotNetTool/Context.cs
- src/DemaConsulting.TemplateDotNetTool/Validation.cs
- src/DemaConsulting.ReviewMark/Context.cs
- src/DemaConsulting.ReviewMark/Validation.cs
# Exclude path-combine warnings in PathHelpers (validated safe usage)
- exclude:
id: cs/path-combine
paths:
- src/DemaConsulting.TemplateDotNetTool/PathHelpers.cs
- src/DemaConsulting.ReviewMark/PathHelpers.cs
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Before submitting this pull request, ensure you have completed the following:
- [ ] Code builds successfully: `dotnet build --configuration Release`
- [ ] All unit tests pass: `dotnet test --configuration Release`
- [ ] Self-validation tests pass:
`dotnet run --project src/DemaConsulting.TemplateDotNetTool --configuration Release --framework net10.0`
`dotnet run --project src/DemaConsulting.ReviewMark --configuration Release --framework net10.0`
`--no-build -- --validate`
- [ ] Code produces zero warnings

Expand Down
40 changes: 20 additions & 20 deletions .github/workflows/build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ jobs:
run: >
dotnet dotnet-sonarscanner
begin
/k:"demaconsulting_TemplateDotNetTool"
/k:"demaconsulting_ReviewMark"
/o:"demaconsulting"
/d:sonar.token="${{ secrets.SONAR_TOKEN }}"
/d:sonar.host.url="https://sonarcloud.io"
Expand Down Expand Up @@ -208,8 +208,8 @@ jobs:
with:
name: packages-${{ matrix.os }}
path: |
src/DemaConsulting.TemplateDotNetTool/bin/Release/*.nupkg
src/DemaConsulting.TemplateDotNetTool/bin/Release/*.snupkg
src/DemaConsulting.ReviewMark/bin/Release/*.nupkg
src/DemaConsulting.ReviewMark/bin/Release/*.snupkg

# Runs CodeQL security and quality analysis, gathering results to include
# in the code quality report.
Expand Down Expand Up @@ -333,7 +333,7 @@ jobs:
dotnet tool install --global \
--add-source packages \
--version ${{ inputs.version }} \
DemaConsulting.TemplateDotNetTool
DemaConsulting.ReviewMark

# === CAPTURE TOOL VERSIONS ===
# This section captures the versions of all tools used in the integration tests.
Expand All @@ -360,22 +360,22 @@ jobs:
- name: Test version display
shell: bash
run: |
echo "Testing templatetool --version..."
templatetool --version || { echo "✗ Version command failed"; exit 1; }
echo "Testing reviewmark --version..."
reviewmark --version || { echo "✗ Version command failed"; exit 1; }
echo "✓ Version command succeeded"

- name: Test help display
shell: bash
run: |
echo "Testing templatetool --help..."
templatetool --help || { echo "✗ Help command failed"; exit 1; }
echo "Testing reviewmark --help..."
reviewmark --help || { echo "✗ Help command failed"; exit 1; }
echo "✓ Help command succeeded"

- name: Run self-validation
shell: bash
run: |
echo "Running self-validation..."
templatetool --validate \
reviewmark --validate \
--results artifacts/validation-${{ matrix.os }}-dotnet${{ matrix.dotnet-version }}.trx \
|| { echo "✗ Self-validation failed"; exit 1; }
echo "✓ Self-validation succeeded"
Expand Down Expand Up @@ -439,14 +439,14 @@ jobs:
- name: Install npm dependencies
run: npm install

- name: Install TemplateTool from package
- name: Install ReviewMark from package
shell: bash
run: |
echo "Installing TemplateTool version ${{ inputs.version }}"
echo "Installing ReviewMark version ${{ inputs.version }}"
dotnet tool install --global \
--add-source packages \
--version ${{ inputs.version }} \
DemaConsulting.TemplateDotNetTool
DemaConsulting.ReviewMark

- name: Restore Tools
run: dotnet tool restore
Expand Down Expand Up @@ -503,7 +503,7 @@ jobs:
dotnet sarifmark
--sarif artifacts/csharp.sarif
--report docs/quality/codeql-quality.md
--heading "Template DotNet Tool CodeQL Analysis"
--heading "ReviewMark CodeQL Analysis"
--report-depth 1

- name: Display CodeQL Quality Report
Expand All @@ -519,7 +519,7 @@ jobs:
run: >
dotnet sonarmark
--server https://sonarcloud.io
--project-key demaconsulting_TemplateDotNetTool
--project-key demaconsulting_ReviewMark
--branch ${{ github.ref_name }}
--token "$SONAR_TOKEN"
--report docs/quality/sonar-quality.md
Expand Down Expand Up @@ -634,42 +634,42 @@ jobs:
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/buildnotes/buildnotes.html
"docs/TemplateDotNetTool Build Notes.pdf"
"docs/ReviewMark Build Notes.pdf"

- name: Generate Guide PDF with Weasyprint
run: >
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/guide/guide.html
"docs/TemplateDotNetTool User Guide.pdf"
"docs/ReviewMark User Guide.pdf"

- name: Generate Code Quality PDF with Weasyprint
run: >
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/quality/quality.html
"docs/TemplateDotNetTool Code Quality.pdf"
"docs/ReviewMark Code Quality.pdf"

- name: Generate Requirements PDF with Weasyprint
run: >
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/requirements/requirements.html
"docs/TemplateDotNetTool Requirements.pdf"
"docs/ReviewMark Requirements.pdf"

- name: Generate Requirements Justifications PDF with Weasyprint
run: >
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/justifications/justifications.html
"docs/TemplateDotNetTool Requirements Justifications.pdf"
"docs/ReviewMark Requirements Justifications.pdf"

- name: Generate Trace Matrix PDF with Weasyprint
run: >
dotnet weasyprint
--pdf-variant pdf/a-3u
docs/tracematrix/tracematrix.html
"docs/TemplateDotNetTool Trace Matrix.pdf"
"docs/ReviewMark Trace Matrix.pdf"

# === UPLOAD ARTIFACTS ===
# This section uploads all generated documentation artifacts.
Expand Down
4 changes: 2 additions & 2 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"build",
"--configuration",
"Release",
"${workspaceFolder}/DemaConsulting.TemplateDotNetTool.slnx"
"${workspaceFolder}/DemaConsulting.ReviewMark.slnx"
],
"problemMatcher": "$msCompile",
"group": {
Expand All @@ -28,7 +28,7 @@
"args": [
"run",
"--project",
"${workspaceFolder}/src/DemaConsulting.TemplateDotNetTool",
"${workspaceFolder}/src/DemaConsulting.ReviewMark",
"--configuration",
"Release",
"--framework",
Expand Down
2 changes: 1 addition & 1 deletion .yamllint.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
# yamllint configuration for Template DotNet Tool
# yamllint configuration for ReviewMark
# This configuration defines the rules for YAML file linting

extends: default
Expand Down
10 changes: 5 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Agent Quick Reference

Project-specific guidance for agents working on Template DotNet Tool - a reference
implementation demonstrating best practices for DEMA Consulting .NET CLI tools.
Project-specific guidance for agents working on ReviewMark - a tool for automated
file-review evidence management in regulated environments.

## Available Specialized Agents

Expand Down Expand Up @@ -36,7 +36,7 @@ implementation demonstrating best practices for DEMA Consulting .NET CLI tools.

## Requirements

- All requirements MUST be linked to tests (prefer `TemplateTool_*` self-validation tests)
- All requirements MUST be linked to tests (prefer `ReviewMark_*` self-validation tests)
- Not all tests need to be linked to requirements (tests may exist for corner cases, design testing, failure-testing, etc.)
- Enforced in CI: `dotnet reqstream --requirements requirements.yaml --tests "test-results/**/*.trx" --enforce`
- When adding features: add requirement + link to test
Expand All @@ -61,7 +61,7 @@ ensures the CI evidence comes specifically from the required environment.

## Testing

- **Test Naming**: `TemplateTool_MethodUnderTest_Scenario` for self-validation tests
- **Test Naming**: `ReviewMark_MethodUnderTest_Scenario` for self-validation tests
- **Self-Validation**: All tests run via `--validate` flag and can output TRX/JUnit format
- **Test Framework**: Uses DemaConsulting.TestResults library for test result generation

Expand Down Expand Up @@ -89,7 +89,7 @@ dotnet build --configuration Release
dotnet test --configuration Release

# Run self-validation
dotnet run --project src/DemaConsulting.TemplateDotNetTool \
dotnet run --project src/DemaConsulting.ReviewMark \
--configuration Release --framework net10.0 --no-build -- --validate

# Use convenience scripts
Expand Down
Loading