search

ashfurrow / danger-ruby-swiftlint

A Danger plugin for SwiftLint.
https://rubygems.org/gems/danger-swiftlint
MIT License
203 stars 81 forks source link

#trivial: README updated to include .directory option and clarification on included files #67

Closed caffeineflo closed 7 years ago

caffeineflo commented 7 years ago

I think a good README is essential to success for a great project. This is certainly a great project, but I spend quite a while (too much that it would still be funny) trying to figure out why the lint issues that I've seen locally wouldn't show up on Danger.

Turns out, #16 made the plugin only lint files that have been modified or added. README referenced #16 but said it was linting all files, which is definitely false. After a dozen runs on debug thinking there was a error on selecting my files, dealing with the ? included option on the SwiftLint config and the directory option on this plugin, I came to the conclusion that setting directory still only lints modified files on PRs.

Therefore I added:

ashfurrow commented 7 years ago

Hi there! First off, let me thank you for the time you've put into this. I definitely agree that a readme is important (I even have receipts) and I apologize that implementation and documentation got out of sync. I'll review the PR immediately.

caffeineflo commented 7 years ago

@ashfurrow I made some clarifications on the directory option explanation. Let me know what you think.