From 9e3118d40b8b185d576bc996e395c35c64a67b17 Mon Sep 17 00:00:00 2001
From: Chris Bandy <chris.bandy@crunchydata.com>
Date: Mon, 9 Dec 2024 16:47:50 -0600
Subject: [PATCH] Add a Make target that searches for note markers

This surfaces the comment convention we inherited from godoc.
We use the parentheses to classify similar notes.

See: https://go.dev/blog/godoc
---
 Makefile | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Makefile b/Makefile
index b861310ce..896a69d4a 100644
--- a/Makefile
+++ b/Makefile
@@ -52,6 +52,10 @@ get-pgmonitor:
 	cp -r '$(PGMONITOR_DIR)/postgres_exporter/common/.' '${QUERIES_CONFIG_DIR}'
 	cp '$(PGMONITOR_DIR)/postgres_exporter/linux/queries_backrest.yml' '${QUERIES_CONFIG_DIR}'
 
+.PHONY: notes
+notes: ## List known issues and future considerations
+	command -v rg > /dev/null && rg '(BUGS|FIXME|NOTE|TODO)[(][^)]+[)]' || grep -Ern '(BUGS|FIXME|NOTE|TODO)[(][^)]+[)]' *
+
 .PHONY: clean
 clean: ## Clean resources
 clean: clean-deprecated