@oddessentials/repo-standards 1.0.1

package/dist/config/standards.csharp-dotnet.json

@@ -0,0 +1,603 @@
+{
+  "checklist": {
+    "core": [
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Maintain proper .gitignore and .dockerignore files to prevent committing secrets, build artifacts, or unnecessary files.",
+        "id": "gitignore-and-dockerignore",
+        "label": "Git and Docker Ignore Files",
+        "stack": {
+          "exampleConfigFiles": [
+            ".gitignore",
+            ".dockerignore"
+          ],
+          "notes": "Use the official github/gitignore VisualStudio/.NET template. .dockerignore must exclude bin/, obj/, .vs/, *.user, and similar local/build artifacts.",
+          "optionalFiles": [
+            ".dockerignore"
+          ],
+          "requiredFiles": [
+            ".gitignore"
+          ],
+          "verification": ".gitignore must exist; .dockerignore is recommended when containerizing or using Docker workflows."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Run static code linting to enforce consistency and catch common issues early.",
+        "id": "linting",
+        "label": "Linting",
+        "stack": {
+          "exampleConfigFiles": [
+            ".editorconfig",
+            "Directory.Build.props"
+          ],
+          "exampleTools": [
+            "Roslyn analyzers",
+            "StyleCop"
+          ],
+          "notes": "Enable analyzers or style rules for the solution and review warnings regularly; enforce stricter rules on new code.",
+          "optionalFiles": [
+            "Directory.Build.props"
+          ],
+          "requiredFiles": [
+            ".editorconfig"
+          ],
+          "requiredScripts": [
+            "lint"
+          ],
+          "verification": ".editorconfig must exist to drive the .NET formatting and analysis tooling."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "test"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Provide a deterministic unit test framework with a single command to run all tests.",
+        "id": "unit-test-runner",
+        "label": "Unit Test Runner",
+        "stack": {
+          "exampleConfigFiles": [
+            "*.Tests.csproj"
+          ],
+          "exampleTools": [
+            "xUnit",
+            "NUnit",
+            "MSTest"
+          ],
+          "notes": "Group unit tests into dedicated test projects and keep them independent from external services.",
+          "optionalFiles": [
+            "*.Tests.csproj"
+          ],
+          "verification": "Test projects are present in the solution; test configuration is defined."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "build"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Provide a Dockerfile and, if applicable, a docker-compose file for local dev and CI parity.",
+        "id": "containerization",
+        "label": "Containerization (Docker / Docker Compose)",
+        "stack": {
+          "exampleConfigFiles": [
+            "Dockerfile",
+            "docker-compose.yml"
+          ],
+          "exampleTools": [],
+          "notes": "Use multi-stage builds for .NET publish output and pin the SDK/runtime image versions to match CI.",
+          "optionalFiles": [
+            "docker-compose.yml"
+          ],
+          "requiredFiles": [
+            "Dockerfile"
+          ],
+          "verification": "Dockerfile must be present; docker-compose.yml is optional and indicates orchestration usage."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "release"
+          },
+          "github-actions": {
+            "job": "release"
+          }
+        },
+        "description": "Use MAJOR.MINOR.PATCH versioning with clear rules and automated changelog generation based on commit history.",
+        "id": "semantic-versioning",
+        "label": "Semantic Versioning",
+        "stack": {
+          "exampleConfigFiles": [
+            "GitVersion.yml",
+            "*.csproj",
+            "CHANGELOG.md"
+          ],
+          "exampleTools": [
+            "GitVersion"
+          ],
+          "notes": "Use GitVersion to automatically compute SemVer from git history and feed it into assembly/package versions. Configure CI to auto-generate or update CHANGELOG.md from commit messages and git tags. Integrate with release pipeline to automatically version assemblies, NuGet packages, and create release notes.",
+          "verification": "Check that versioning is driven by a SemVer-aware tool (for example, GitVersion) and verify that running the release/versioning step locally or in CI automatically produces the expected version metadata, updates project files, and generates changelog entries from commit history."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Enforce structured commit messages such as Conventional Commits.",
+        "id": "commit-linting",
+        "label": "Commit Linting",
+        "stack": {
+          "exampleConfigFiles": [
+            "commitlint.config.*",
+            ".cz.toml"
+          ],
+          "exampleTools": [
+            "commitlint",
+            "commitizen"
+          ],
+          "notes": "Document your commit convention and wire up a helper tool so contributors can easily follow it.",
+          "verification": "Create a test commit following the documented commit convention and confirm that any configured commit message checks (local hooks or CI) accept the message."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "test"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Generate readable unit test and coverage reports and enforce a minimum coverage threshold (around 80%) for new or changed code.",
+        "id": "unit-test-reporter",
+        "label": "Unit Test Reporter / Coverage",
+        "stack": {
+          "exampleConfigFiles": [
+            "*.csproj"
+          ],
+          "exampleTools": [
+            "coverlet",
+            "ReportGenerator"
+          ],
+          "notes": "Enable coverage collection for test projects and publish reports in a human-friendly format from CI.",
+          "verification": "Run the test suite with coverage enabled (for example, using coverlet or a similar tool) and verify that coverage reports are generated and used in CI to monitor thresholds."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "ci"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Single CI pipeline that runs linting, formatting, type checking, tests, coverage, build, and containerization.",
+        "id": "ci-quality-gates",
+        "label": "CI Quality Gates",
+        "stack": {
+          "exampleConfigFiles": [
+            ".github/workflows/*",
+            "azure-pipelines.yml"
+          ],
+          "exampleTools": [],
+          "notes": "Ensure CI runs analyzers, tests, build, and packaging or container checks before changes can be merged.",
+          "verification": "Open the CI configuration and verify there is a job or stage that runs analyzers, tests, build, and any required packaging or container checks before merging to main."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Automatic code formatting to maintain a consistent style across all contributors.",
+        "id": "code-formatter",
+        "label": "Code Formatter",
+        "stack": {
+          "exampleConfigFiles": [
+            ".editorconfig"
+          ],
+          "exampleTools": [
+            "dotnet format"
+          ],
+          "notes": "Use .editorconfig and dotnet-format to keep C# style consistent across contributors.",
+          "verification": "Run the configured formatter or code style enforcement (for example, `dotnet format`) and confirm that code in the repository conforms to the defined rules."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Use git hooks to run linting, formatting, tests, and commit linting before changes are committed.",
+        "id": "pre-commit-hooks",
+        "label": "Pre-Commit Hooks",
+        "stack": {
+          "exampleConfigFiles": [
+            "lefthook.yml"
+          ],
+          "exampleTools": [
+            "Lefthook"
+          ],
+          "notes": "Configure Lefthook or similar to run formatting and basic checks on staged files before commits.",
+          "verification": "Inspect the hook configuration (for example, Lefthook or similar) and confirm it runs at least formatting and basic checks on staged changes before commits or pushes."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Use static type checking to catch errors before runtime and enforce strictness on new code.",
+        "id": "type-checking",
+        "label": "Type Checking",
+        "stack": {
+          "exampleConfigFiles": [
+            ".editorconfig",
+            "Directory.Build.props",
+            "*.csproj"
+          ],
+          "exampleTools": [
+            "Roslyn analyzers"
+          ],
+          "notes": "Enable nullable reference types and relevant analyzers to catch type and nullability issues at compile time. C# project files (*.csproj) indicate the presence of projects that can be type-checked.",
+          "optionalFiles": [
+            "Directory.Build.props"
+          ],
+          "requiredFiles": [
+            ".editorconfig"
+          ],
+          "requiredScripts": [
+            "typecheck"
+          ],
+          "verification": ".editorconfig must exist; Directory.Build.props is optional for shared build configuration."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Lock dependencies and scan regularly for known vulnerabilities; fail CI on newly introduced high-severity issues.",
+        "id": "dependency-security",
+        "label": "Dependency Management & Vulnerability Scanning",
+        "stack": {
+          "exampleConfigFiles": [
+            "packages.lock.json",
+            "*.csproj"
+          ],
+          "exampleTools": [
+            "dotnet list package --vulnerable"
+          ],
+          "notes": "Enable package lock files and use vulnerability scanning to track and remediate high-risk dependencies.",
+          "optionalFiles": [
+            "packages.lock.json"
+          ],
+          "verification": "Dependency lockfile or package reference is present; security scanning is configured."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Specify required runtime/engine versions in package manifests to ensure environment stability and prevent version-related issues across development teams.",
+        "id": "runtime-version",
+        "label": "Runtime Version Specification",
+        "stack": {
+          "exampleConfigFiles": [
+            "*.csproj",
+            "global.json"
+          ],
+          "exampleTools": [],
+          "notes": "Specify TargetFramework in .csproj files (e.g., <TargetFramework>net8.0</TargetFramework>) and optionally use global.json to pin the SDK version (e.g., { \"sdk\": { \"version\": \"8.0.100\" } }) for consistent builds across the team.",
+          "optionalFiles": [
+            "global.json"
+          ],
+          "verification": ".csproj files must specify TargetFramework; global.json is recommended to pin SDK version."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "docs"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Maintain a comprehensive README and, where applicable, auto-generated API docs to support onboarding and maintainability.",
+        "id": "documentation",
+        "label": "Documentation Standards",
+        "stack": {
+          "exampleConfigFiles": [
+            "README.md",
+            "docfx.json"
+          ],
+          "exampleTools": [
+            "DocFX"
+          ],
+          "notes": "Keep README and API docs in sync with the solution structure and public surface area.",
+          "optionalFiles": [
+            "docs/",
+            "docfx.json"
+          ],
+          "requiredFiles": [
+            "README.md"
+          ],
+          "verification": "README.md is present in the repository root; docs/ directory or DocFX configuration exists if applicable."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "governance"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Include standard governance files (LICENSE, CODE_OF_CONDUCT.md, CONTRIBUTING.md), branch protection rules, and review standards to define legal, ethical, and workflow expectations.",
+        "id": "repository-governance",
+        "label": "Repository Governance",
+        "stack": {
+          "exampleConfigFiles": [
+            "LICENSE",
+            "CODE_OF_CONDUCT.md",
+            "CONTRIBUTING.md"
+          ],
+          "exampleTools": [],
+          "notes": "Document contribution expectations and ensure legal and code-of-conduct policies are easy to find.",
+          "optionalFiles": [
+            "CODE_OF_CONDUCT.md",
+            "CONTRIBUTING.md"
+          ],
+          "requiredFiles": [
+            "LICENSE"
+          ],
+          "verification": "LICENSE file is present in the repository root; CODE_OF_CONDUCT.md and CONTRIBUTING.md are present for contribution guidance."
+        }
+      }
+    ],
+    "optionalEnhancements": [
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "observability"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Standardize error handling and structured logging to make debugging and production monitoring easier.",
+        "id": "observability",
+        "label": "Observability (Logging & Error Handling)",
+        "stack": {
+          "exampleConfigFiles": [
+            "appsettings.json"
+          ],
+          "exampleTools": [
+            "Serilog",
+            "NLog"
+          ],
+          "notes": "Configure structured logging for your .NET services and ensure exceptions and key events are logged with useful context.",
+          "verification": "Confirm that a structured logging library (such as Serilog or NLog) is configured with an agreed sink and format, and that the application logs meaningful context for errors and key events."
+        }
+      }
+    ],
+    "recommended": [
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "test"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Test how components interact with each other and external systems, running after unit tests with more relaxed coverage thresholds.",
+        "id": "integration-testing",
+        "label": "Integration Testing",
+        "stack": {
+          "exampleConfigFiles": [
+            "*.IntegrationTests.csproj"
+          ],
+          "exampleTools": [
+            "xUnit",
+            "NUnit",
+            "MSTest"
+          ],
+          "notes": "Create dedicated integration test projects that exercise real infrastructure or service boundaries where appropriate.",
+          "verification": "Confirm there is a test project or configuration dedicated to integration or API tests and run it to verify external or cross-service interactions behave as expected."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "performance"
+          },
+          "github-actions": {
+            "job": "performance"
+          }
+        },
+        "description": "Establish performance baselines and monitor for regressions using lightweight benchmarks or audits in CI.",
+        "id": "performance-baselining",
+        "label": "Performance Baselines",
+        "stack": {
+          "exampleConfigFiles": [
+            "*.csproj"
+          ],
+          "exampleTools": [
+            "BenchmarkDotNet"
+          ],
+          "notes": "Use BenchmarkDotNet or similar to track performance of critical methods or endpoints over time.",
+          "verification": "Identify and run the configured performance or benchmarking suite (for example, BenchmarkDotNet) and review the output to ensure it is tracked against historical or target values."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Measure cyclomatic complexity or similar metrics to keep code maintainable, starting as a warning-only check.",
+        "id": "complexity-analysis",
+        "label": "Complexity Analysis",
+        "stack": {
+          "exampleConfigFiles": [
+            "sonar-project.properties"
+          ],
+          "exampleTools": [
+            "SonarQube",
+            "Visual Studio code metrics"
+          ],
+          "notes": "Use code metrics or Sonar analysis to flag overly complex methods and refactor them over time.",
+          "verification": "Run the configured code metrics or Sonar analysis and review complexity reports for key modules, ensuring that new or changed code stays within acceptable limits."
+        }
+      },
+      {
+        "ciHints": {
+          "azure-devops": {
+            "stage": "quality"
+          },
+          "github-actions": {
+            "job": "ci"
+          }
+        },
+        "description": "Run accessibility checks on web-facing components to detect critical issues and improve inclusive UX.",
+        "id": "accessibility-auditing",
+        "label": "Accessibility Auditing",
+        "stack": {
+          "exampleConfigFiles": [],
+          "exampleTools": [
+            "axe-core",
+            "Accessibility Insights"
+          ],
+          "notes": "Apply accessibility tooling to ASP.NET or Blazor front-ends and review issues alongside functional testing.",
+          "verification": "For web-facing apps, run the configured accessibility checks or tools against your main UI endpoints and confirm that blocking accessibility issues are addressed."
+        }
+      }
+    ]
+  },
+  "ciSystems": [
+    "azure-devops",
+    "github-actions"
+  ],
+  "meta": {
+    "complexityChecks": {
+      "description": "When supported by the stack, run cyclomatic complexity or similar metrics in CI as a warning-only check initially.",
+      "enabledByDefault": true
+    },
+    "defaultCoverageThreshold": 0.8,
+    "migrationGuide": [
+      {
+        "description": "Start by adding pre-commit hooks and core formatting/linting so developers get fast feedback without touching CI.",
+        "focusIds": [
+          "pre-commit-hooks",
+          "linting",
+          "code-formatter"
+        ],
+        "notes": "Keep hooks fast and focused on changed files to avoid slowing down day-to-day work.",
+        "step": 1,
+        "title": "Establish Local Safety Nets First"
+      },
+      {
+        "description": "Introduce CI quality gates that mirror local checks, but treat existing violations as warnings wherever possible.",
+        "focusIds": [
+          "ci-quality-gates",
+          "linting",
+          "code-formatter",
+          "commit-linting"
+        ],
+        "notes": "Use diff-based tools or baselines so only new violations break builds; legacy issues remain visible but non-blocking.",
+        "step": 2,
+        "title": "Mirror Local Checks in CI (Soft-Fail on Legacy)"
+      },
+      {
+        "description": "Enable type-checking, coverage thresholds, and dependency/vulnerability scanning with gradual enforcement.",
+        "focusIds": [
+          "type-checking",
+          "unit-test-runner",
+          "unit-test-reporter",
+          "dependency-security"
+        ],
+        "notes": "Pin tool and runtime versions in CI and containers to avoid flaky differences across environments.",
+        "step": 3,
+        "title": "Add Type Safety, Coverage, and Dependency Security"
+      },
+      {
+        "description": "Add documentation standards, governance files, integration testing, performance baselines, complexity analysis, accessibility auditing, and (optionally) ML-specific practices for data-heavy Python repos.",
+        "focusIds": [
+          "documentation",
+          "repository-governance",
+          "integration-testing",
+          "performance-baselining",
+          "complexity-analysis",
+          "accessibility-auditing"
+        ],
+        "notes": "Tackle recommended items in order of business value; backend-only repos can skip web-focused checks like accessibility. For AI/ML-heavy Python teams, consider extending containerization with data versioning (DVC) and unit tests with data quality checks (e.g., Great Expectations) as part of this step.",
+        "step": 4,
+        "title": "Layer in Docs, Governance, and Recommended Checks"
+      }
+    ],
+    "qualityGatePolicy": {
+      "description": "New quality checks should warn on existing code and fail CI only for violations introduced in new or changed code, to reduce friction on legacy codebases.",
+      "preferSoftFailOnLegacy": true
+    }
+  },
+  "stack": "csharp-dotnet",
+  "stackLabel": "C# / .NET",
+  "version": 1
+}