-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
add editor setup tips to contrib guide #2280
Conversation
CONTRIBUTING.md
Outdated
|
||
- Be warned, IntelliJ is currently not 100% accurate at reporting compilation errors, there *will* be cases that it reports errors incorrectly. If you simply don't want to see the errors, a quick an easy work around is to disable *Type-Aware Highlighting* by clicking the `[T]` icon in the bottom toolbar. | ||
|
||
- There is an open [issue](https://github.com/typelevel/cats/issues/2152) with the IntelliJ scala plugin, which prevents it from configuring similacrum correctly when importing the cats project. The work around for this issue is to set `val CompileTime = Provided` in `build.sbt`. Note: Be careful not to commit this change. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just curious, did you verify that this val CompileTime = Provided
works?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. It worked great. I was trying to find a way to detect if the build was invoked by inteliij and automatically switch it, but couldn't find a way to do that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot! This will be helpful.
Codecov Report
@@ Coverage Diff @@
## master #2280 +/- ##
=======================================
Coverage 95.06% 95.06%
=======================================
Files 338 338
Lines 5855 5855
Branches 219 219
=======================================
Hits 5566 5566
Misses 289 289 Continue to review full report at Codecov.
|
Merge conflicts here. would you please do a rebase? |
46c19e9
to
aa44de4
Compare
@kailuowang Done |
I am new to contributing to Cats, and ran into quite a few difficulties setting up IntelliJ with the project. I have documented the issues I hit and how to resolve them in the contributors guide.