palantir/policy-bot

Misleading documentation about file path regular expressions

srabraham opened this issue · 1 comments

The documentation makes it look like path regexps implicitly anchor at the start and end, but I've confirmed for myself that this isn't the case. It'd probably be better to just put "^" and "$" on each of the paths/ignores in the documentation, to avoid confusion for others. For example, "^server/views/.*\\.tmpl$" rather than "server/views/.*\\.tmpl".

See screenshot from README.md for context.

image

Good point, this could be confusing. I added explicit anchors in #625.