s1d3sw1ped/steamcache2
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 20 Wiki Activity

Update AGENTS.md and Makefile for review hygiene guidelines

Browse Source 
- 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.
This commit is contained in:
Justin Harms
2026-05-27 03:07:25 -05:00
parent ffa9aa04f7
commit 4861f93e6f
3 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
AGENTS.md
+5 -1
View File
@@ -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).
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.
Makefile
+1 -1
View File
@@ -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
README.md
-2
View File
@@ -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: