chore: Triage and clean up TODO comments

.github/pull_request_template.md

@@ -64,3 +64,4 @@ Not applicable items should be crossed out, not removed.
 - [ ] `CHANGELOG.md`, `README.md`, `DEVELOPER.md`, and other documentation files are updated.
 - [ ] Destination branch is correct - `main` or release
 - [ ] Create merge commit if merging release branch into `main`, squash otherwise.
+- [ ] All TODOs referencing issue(s) closed by this PR have been resolved.

.github/workflows/cd.yml

@@ -158,8 +158,12 @@ jobs:
             - name: Pack the client
               working-directory: sources/Valkey.Glide
               run: |
-                  dotnet build Valkey.Glide.csproj --configuration Release "/property:Version=$RELEASE_VERSION"
-                  dotnet pack Valkey.Glide.csproj --configuration Release "-p:NuspecProperties=version=$RELEASE_VERSION"
+                  dotnet build Valkey.Glide.csproj \
+                    --configuration Release \
+                    "/property:Version=$RELEASE_VERSION"
+                  dotnet pack Valkey.Glide.csproj \
+                    --configuration Release \
+                    "-p:NuspecProperties=version=$RELEASE_VERSION;commit=${{ github.sha }}"
                   tree -h bin/Release
                   unzip -l "bin/Release/Valkey.Glide.$RELEASE_VERSION.nupkg"
                   unzip -l "bin/Release/Valkey.Glide.$RELEASE_VERSION.snupkg"

.github/workflows/check-examples.yml

@@ -38,4 +38,4 @@ jobs:
               run: task build target=lib
 
             - name: Check examples
-              run: task check-examples
+              run: task check:examples

.github/workflows/check-todos.yml

@@ -0,0 +1,34 @@
+name: check-todos
+
+on:
+    push:
+        branches:
+            - main
+            - release-*
+    pull_request:
+    workflow_dispatch:
+
+permissions:
+    contents: read
+    issues: read
+
+jobs:
+    check-todos:
+        runs-on: ubuntu-latest
+        timeout-minutes: 10
+
+        steps:
+            - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
+
+            - name: Setup Python
+              uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6.3.0
+              with:
+                  python-version: "3.12"
+
+            - name: Install Task
+              uses: go-task/setup-task@01a4adf9db2d14c1de7a560f09170b6e0df736aa # v2.1.0
+
+            - name: Check TODOs
+              run: task check:todos
+              env:
+                  GH_TOKEN: ${{ github.token }}

.github/workflows/test.yml

@@ -81,8 +81,8 @@ jobs:
             - name: Determine whether to run with coverage
               shell: bash
               run: |
-                  SERVER_TYPE=$(jq -r '.server_type' dev/coverage/coverage-baseline.json)
-                  SERVER_VERSION=$(jq -r '.server_version' dev/coverage/coverage-baseline.json)
+                  SERVER_TYPE=$(jq -r '.server_type' dev/conf/coverage-baseline.json)
+                  SERVER_VERSION=$(jq -r '.server_version' dev/conf/coverage-baseline.json)
 
                   RUN_COVERAGE=false
                   if [[ "${{ matrix.dotnet }}" == "8.0" \

AGENTS.md

@@ -40,16 +40,6 @@ Common commands:
   - `task test coverage=true` (collect), `task coverage:report` (generate)
   - Coverage results go to `dev/coverage/results/`; reports to `dev/coverage/reports/`
 
-## Lint and Format Rules (Agents)
-
-- Prefer `task` commands for linting and formatting.
-- Lint checks (read-only, fail on issues):
-  - `task lint` (all checks), `task lint:rust`, `task lint:csharp`, `task lint:yaml`, `task lint:actions`, `task lint:markdown`
-- Auto-fix formatting:
-  - `task format` (all languages), `task format:rust`, `task format:csharp`, `task format:yaml`, `task format:markdown`
-- Link checking (separate from lint, slower):
-  - `task check-links`
-
 ## Contribution Requirements
 
 ### Developer Certificate of Origin (DCO) Signoff
@@ -159,12 +149,12 @@ Note: Conventional Commits apply to commit messages only. Do not enforce this fo
 
 ## Quality Gates (Agent Checklist)
 
-- [ ] Build passes
-- [ ] Format passes
-- [ ] Lint passes
-- [ ] All unit tests pass
-- [ ] Relevant integration tests pass
-- [ ] Documentation examples compile
+- [ ] Build passes (`task build`)
+- [ ] [Formatting](DEVELOPER.md#formatting) passes (`task format`)
+- [ ] [Linting](DEVELOPER.md#linting) passes (`task lint`)
+- [ ] [Checks](DEVELOPER.md#checks) pass (`task check`)
+- [ ] All unit tests pass (`task test:unit`)
+- [ ] Relevant integration tests pass (`task test:integration`)
 - [ ] Public API changes respect StackExchange.Redis compatibility.
 - [ ] All commits include DCO signoff.
 

DEVELOPER.md

@@ -250,8 +250,7 @@ task coverage:clean   # Remove coverage results and reports
 # Linting and formatting
 task lint                   # Run all linters
 task format                 # Run all formatters
-task check-links            # Check for broken links
-
+task check                  # Run all checks
 ```
 
 ## Advanced Testing Options
@@ -339,34 +338,57 @@ To run [DNS tests](tests/Valkey.Glide.IntegrationTests/DnsTests.cs) locally:
 
 If the environment variable is not set, DNS tests will be skipped.
 
-## Linting and Formatting
+## Formatting
+
+Run automated formatters to ensure consistent code style.
+
+```bash
+task format           # Run all formatters
+task format:rust      # Run Rust formatter
+task format:csharp    # Run C# formatter
+task format:yaml      # Run YAML formatter
+task format:markdown  # Run Markdown formatter
+```
+
+## Linting
+
+Run linters to catch style issues and static analysis warnings.
+
+```bash
+task lint           # Run all linters
+task lint:rust      # Run Rust linter
+task lint:csharp    # Run C# linter
+task lint:yaml      # Run YAML linter
+task lint:actions   # Run GitHub Actions linter
+task lint:markdown  # Run Markdown linter
+```
+
+## Checks
 
-Before making a contribution, ensure that all new user APIs and non-obvious code is well documented, and run the code linters and analyzers.
+Run checks to validate examples, links, and TODOs.
 
 ```bash
-# Run all linters:
-task lint
-
-# Run linters for specific languages:
-task lint:rust      # Run Rust linting
-task lint:csharp    # Run C# linting
-task lint:yaml      # Run YAML linting
-task lint:actions   # Run GitHub Actions linting
-task lint:markdown  # Run Markdown linting
-
-# Run all formatters:
-task format
-
-# Run formatters for specific languages:
-task format:rust
-task format:csharp
-task format:yaml
-task format:markdown
-
-# Check for broken links
-task check-links
+task check
+task check:examples
+task check:links
+task check:todos
 ```
 
+### TODOs
+
+All TODOs must follow the format `TODO #<number>: <description>`, where:
+
+- `<number>` is an open GitHub issue in this repository.
+- `<description>` is a short explanation of what needs to change (at least 10 characters).
+
+Example:
+
+```csharp
+// TODO #472: Auto-generate this enum from the Rust source.
+```
+
+Files can be excluded from validation via `dev/conf/check-todos-ignore` (fnmatch glob patterns, one per line).
+
 ## Test framework and Style
 
 The CSharp Valkey-Glide client uses xUnit v3 for testing code. The test code styles are defined in `.editorconfing` (see `dotnet_diagnostic.xUnit..` rules). The xUnit rules are enforced by the [xUnit analyzers](https://github.com/xunit/xunit.analyzers) referenced in the main xunit.v3 NuGet package. If you choose to use xunit.v3.core instead, you can reference xunit.analyzers explicitly. For additional info, please, refer to <https://xunit.NET> and <https://github.com/xunit/xunit>

Taskfile.yml

@@ -126,15 +126,15 @@ tasks:
 
     lint:yaml:
         desc: "Run YAML linting"
-        cmd: npx prettier --check "**/*.yml"
+        cmd: npx --yes prettier --check "**/*.yml"
 
     lint:actions:
         desc: "Run GitHub Actions linting"
         cmd: actionlint
 
     lint:markdown:
         desc: "Run Markdown linting"
-        cmd: npx markdownlint-cli2 "**/*.md"
+        cmd: npx --yes markdownlint-cli2 "**/*.md"
 
     # Format
     # --------------------------------------------------------------------------------
@@ -158,19 +158,30 @@ tasks:
 
     format:yaml:
         desc: "Run YAML formatting"
-        cmd: npx prettier --write --cache "**/*.yml"
+        cmd: npx --yes prettier --write --cache "**/*.yml"
 
     format:markdown:
         desc: "Run Markdown formatting"
-        cmd: npx markdownlint-cli2 --fix "**/*.md"
+        cmd: npx --yes markdownlint-cli2 --fix "**/*.md"
 
     # Additional checks
     # --------------------------------------------------------------------------------
 
-    check-links:
+    check:
+        desc: "Run all checks"
+        deps:
+            - check:examples
+            - check:links
+            - check:todos
+
+    check:examples:
+        desc: "Check C# examples in comments"
+        cmd: python3 dev/scripts/check_examples.py
+
+    check:links:
         desc: "Check for broken links"
         cmd: lychee --config lychee.toml .
 
-    check-examples:
-        desc: "Check C# examples in doc comments"
-        cmd: python3 dev/scripts/check_examples.py
+    check:todos:
+        desc: "Check that TODOs reference an open GitHub issue"
+        cmd: python3 dev/scripts/check_todos.py

dev/conf/check-todos-ignore

@@ -0,0 +1,8 @@
+# Files excluded from the TODO checker.
+# Patterns use fnmatch-style glob matching.
+# Only full-line comments supported.
+# See dev/scripts/check_todos.py for details.
+
+dev/conf/check-todos-ignore
+dev/scripts/check_todos.py
+DEVELOPER.md

dev/coverage/coverage-baseline.json → dev/conf/coverage-baseline.json

@@ -2,5 +2,5 @@
   "server_type": "valkey",
   "server_version": "9.0",
   "line_coverage": 71.4,
-  "branch_coverage": 52.1
+  "branch_coverage": 51.9
 }

dev/scripts/_constants.py

@@ -7,16 +7,20 @@
 # Paths
 # ---------------------------------------------------------------------------
 
+GITHUB_REPO = "valkey-io/valkey-glide-csharp"
+
 SCRIPTS_DIR = os.path.dirname(os.path.abspath(__file__))
 PROJECT_ROOT = os.path.dirname(os.path.dirname(SCRIPTS_DIR))
 SOURCES_DIR = os.path.join(PROJECT_ROOT, "sources")
 LIBRARY_DIR = os.path.join(SOURCES_DIR, "Valkey.Glide")
 
+CONF_DIR = os.path.join(PROJECT_ROOT, "dev", "conf")
+COVERAGE_BASELINE_PATH = os.path.join(CONF_DIR, "coverage-baseline.json")
+COVERAGE_RUNSETTINGS_PATH = os.path.join(CONF_DIR, "coverage-runsettings.xml")
+
 COVERAGE_DIR = os.path.join(PROJECT_ROOT, "dev", "coverage")
 COVERAGE_RESULTS_DIR = os.path.join(COVERAGE_DIR, "results")
 COVERAGE_REPORTS_DIR = os.path.join(COVERAGE_DIR, "reports")
-COVERAGE_BASELINE_PATH = os.path.join(COVERAGE_DIR, "coverage-baseline.json")
-COVERAGE_RUNSETTINGS_PATH = os.path.join(COVERAGE_DIR, ".runsettings")
 
 COVERAGE_REPORTS_COMBINED_DIR = os.path.join(COVERAGE_REPORTS_DIR, "combined")
 COVERAGE_REPORT_COMBINED_INDEX_PATH = os.path.join(

dev/scripts/check_examples.py

@@ -2,8 +2,11 @@
 
 """Check code examples by extracting and compiling them.
 
+Extracts C# code examples from XML doc comments in the source tree, then
+compiles each against the built Valkey.Glide DLL to verify correctness.
+
 Usage:
-    python scripts/check_examples.py
+    python dev/scripts/check_examples.py
 """
 
 import os