Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fail-fast behaviour vs. detailed reports #1

Open
laughedelic opened this issue Jun 1, 2018 · 0 comments
Open

Fail-fast behaviour vs. detailed reports #1

laughedelic opened this issue Jun 1, 2018 · 0 comments
Labels
discussion Opinions are welcome help wanted Extra attention is needed
Milestone

Comments

@laughedelic
Copy link
Owner

On one hand Checks API provides some means to make detailed reports with comments on particular lines of sources. So when the formatting check fails, it could generate a diff and comment on the pieces of the mis-formatted code.

On the other hand I personally don't see much value in such detailed reports. I would prefer the check to fail on the first mis-formatted file and report immediately, so that the feedback would be quick. I think that in most cases you don't care what exactly was mis-formatted, you just forgot to do it and as soon as you got this reminder on GitHub, you can just run scalafmt locally (in whatever preferred way) and fix it.

It could be a configuration option, but I would like to avoid a bot-specific configuration and even if there was one, I want to choose a sensible default.

@laughedelic laughedelic added discussion Opinions are welcome help wanted Extra attention is needed labels Jun 1, 2018
@laughedelic laughedelic mentioned this issue Jun 1, 2018
@laughedelic laughedelic added this to the v0.1.0 milestone Jun 1, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussion Opinions are welcome help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant