Skip to content

Commit 917ac46

Browse files
lwjohnst86signekb
andauthored
feat: ✨ add recipe to template justfile to list all TODO items (#79)
# Description There are several TODO items sprinkled throughout the template that need to be addressed after creating the template. This adds a recipe to make it easier to list them. This PR needs a quick review. --------- Co-authored-by: Signe Kirk Brødbæk <[email protected]>
1 parent d36aa8c commit 917ac46

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

template/README.md.jinja

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Post-setup steps
2+
3+
- Run `just list-todos` to get a list of TODO items you need to fill out.

template/justfile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@
55
run-all: install-deps format-python check-python check-spelling check-commits build
66

77

8+
# List all TODO items in the repository
9+
list-todos:
10+
grep -R -n --exclude="*.code-snippets" "TODO" *
11+
812
# Install the pre-commit hooks
913
install-precommit:
1014
# Install pre-commit hooks

0 commit comments

Comments
 (0)