From be8ba90cba36a886acc2d32c0cc0e9c0e9acbab3 Mon Sep 17 00:00:00 2001 From: currantw Date: Tue, 21 Jul 2026 17:10:33 -0700 Subject: [PATCH 01/31] feat: Add `check-todos` task and GitHub workflow Add a Python script that validates all TODO comments reference an open GitHub issue. TODOs must use the format `TODO #` inside a comment marker (// # /* * README.md icon.png - + open-source performance database csharp key-value fault-tolerance cache reliability pubsub valkey valkey-client Copyright © 2025 Valkey GLIDE Maintainers - - + https://github.com/valkey-io/valkey-glide-csharp/releases @@ -29,8 +27,9 @@ - - + From 287825e68722e40e9845d6ef3cf09e028280b42e Mon Sep 17 00:00:00 2001 From: currantw Date: Thu, 23 Jul 2026 08:01:02 -0700 Subject: [PATCH 09/31] Add a minimum description length Signed-off-by: currantw --- dev/scripts/check_todos.py | 37 ++++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/dev/scripts/check_todos.py b/dev/scripts/check_todos.py index 96f7174f..7130d2f1 100644 --- a/dev/scripts/check_todos.py +++ b/dev/scripts/check_todos.py @@ -1,11 +1,11 @@ #!/usr/bin/env python3 -"""Check that all TODO comments reference an open GitHub issue. +"""Check that all TODO comments follow the required format. Validation rules: - 1. Every TODO must include a GitHub issue reference with format `TODO #`. - 2. The referenced number must correspond to an existing Valkey GLIDE C# GitHub issue. - 3. The referenced issue must be open. + 1. Every TODO must follow the format `TODO #: `. + 2. The description should provide a summary of the proposed changes, and must be at least 10 characters long. + 3. The referenced number must correspond to an open Valkey GLIDE C# GitHub issue. Usage: python dev/scripts/check_todos.py @@ -30,10 +30,16 @@ class _Todo(NamedTuple): text: str +# Matches TODO comments and captures GitHub issue ID and description. _TODO_PATTERN = re.compile( - r"(//|#|/\*|\*|