Skip to content

Commit e2e02f3

Browse files
author
ABaldwinHunter
committed
Update readme
Include `XXX` in list of target words and call out that match is case sensitive. Update description of tool behavior to clarify that strings can be found outside of comments as well.
1 parent c3ca9c1 commit e2e02f3

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

Diff for: README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
# Code Climate FIXME Engine
22

3-
`codeclimate-fixme` is a Code Climate engine that finds comments in your code which match the following strings:
3+
`codeclimate-fixme` is a Code Climate engine that performs a case-sensitive search for the following strings in your project:
44

55
* `TODO`
66
* `FIXME`
77
* `HACK`
88
* `BUG`
9+
* `XXX`
910

1011
These strings are things you should fix now, not later.
1112

0 commit comments

Comments
 (0)