Skip to content

Commit 97acc59

Browse files
committed
Added sample comments to show the app's functionality
1 parent 259f6fb commit 97acc59

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# TODO: Many different file types are supported, but if you are missing one, feel free to open an issue!
2+
13
name: Create Github Release
24

35
on:

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,12 @@
33
<p align="center">
44
<img src="./development/images/icon/images/icon.png" width="150" alt="Todo PR Checker">
55
</p>
6-
6+
<!-- The app will only report on TODO items in code comments -->
77
Do you keep forgetting to resolve that one `// TODO:...` or fix the last ` # Bug...` before merging your Pull Requests?
8+
<!--
9+
The capitalization of the todo, FixMe or BUG does not matter.
10+
Neither does it, where in the comment the TODO is located.
11+
-->
812

913
The Todo PR Checker will make sure that doesn't happen anymore.
1014
The app checks all code changes in your open Pull Requests for remaining `Todo`, `Fixme` etc. action items in code comments and leaves a comment on the PR with embedded code links to any items that were found.

0 commit comments

Comments
 (0)