From 4861f93e6f72b6bc23a676ac8b1bacec432de7fb Mon Sep 17 00:00:00 2001 From: Justin Harms Date: Wed, 27 May 2026 03:07:25 -0500 Subject: [PATCH] Update AGENTS.md and Makefile for review hygiene guidelines - Added a new section in AGENTS.md outlining the importance of not leaving temporary review labels in source code or comments. - Updated the error message in the Makefile's check-review-labels target to reference AGENTS.md for review hygiene rules instead of plans/README.md, ensuring consistency in documentation. --- AGENTS.md | 6 +++++- Makefile | 2 +- README.md | 2 -- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index cdf4e71..8fa0054 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,4 +2,8 @@ This repository has established best practices, preferred patterns, and coding guidelines. -Before making changes, proposing implementations, or working on tasks, please read the README.md (particularly the Development Workflow and any linked sections on conventions and process). \ No newline at end of file +Before making changes, proposing implementations, or working on tasks, please read the README.md (particularly the Development Workflow and any linked sections on conventions and process). + +## Review & Implementation Hygiene + +**Important rule**: Do not leave temporary review labels (P2-05, T1, I3, R2, "per Issue 7", etc.) in source code or comments. `make check-review-labels` (part of `make lint`) will catch violations. \ No newline at end of file diff --git a/Makefile b/Makefile index ebd4fbf..645bb95 100644 --- a/Makefile +++ b/Makefile @@ -18,7 +18,7 @@ lint: deps check-review-labels ## Run golangci-lint + review label hygiene check @golangci-lint run ./... check-review-labels: ## Fail if temporary review labels (P0-01, T1, I3, R2, etc.) are found in source - @! grep -rnE '\b[A-Z][0-9][^a-zA-Z]' --include='*.go' . 2>/dev/null | grep -v 'G[0-9]\{3\}' || (echo "Error: Found temporary review labels (P*, T*, I*, etc.) in source. See plans/README.md for the rule." && exit 1) + @! grep -rnE '\b[A-Z][0-9][^a-zA-Z]' --include='*.go' . 2>/dev/null | grep -v 'G[0-9]\{3\}' || (echo "Error: Found temporary review labels (P*, T*, I*, etc.) in source. See AGENTS.md for the rule." && exit 1) deps: ## Download dependencies @go mod tidy diff --git a/README.md b/README.md index 96f9cf2..322ec2f 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,6 @@ Run `make help` to see the full list of available commands. This is the preferred approach for day-to-day development. Avoid running raw `go test`, `go run`, or `golangci-lint` commands directly for routine tasks. -**Important rule**: Do not leave temporary review labels (P2-05, T1, I3, R2, "per Issue 7", etc.) in source code or comments. See `plans/README.md` → "Review & Implementation Hygiene" for details. `make check-review-labels` (part of `make lint`) will catch violations. - ### Command Line Flags While most configuration is done via the YAML file, some runtime options are still available as command-line flags: