add editor setup tips to contrib guide #2280
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kailuowang
reviewed
Jun 5, 2018
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.
Just curious, did you verify that this val CompileTime = Provided works?
There was a problem hiding this comment.
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.
kailuowang
previously approved these changes
Jun 5, 2018
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 289Continue to review full report at Codecov.
|
|
Merge conflicts here. would you please do a rebase? |
eli-jordan
force-pushed
the
contrib-guide-editors
branch
from
46c19e9
to
aa44de4
Compare
|
@kailuowang Done |
LukaJCB
approved these changes
Jun 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.