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

add editor setup tips to contrib guide #2280

Merged
merged 1 commit into from
Jun 26, 2018

Conversation

eli-jordan
Copy link
Contributor

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.

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.
Copy link
Contributor

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?

Copy link
Contributor Author

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.

kailuowang
kailuowang previously approved these changes Jun 5, 2018
Copy link
Contributor

@kailuowang kailuowang left a 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-io
Copy link

codecov-io commented Jun 5, 2018

Codecov Report

Merging #2280 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 89538e7...aa44de4. Read the comment docs.

@kailuowang
Copy link
Contributor

kailuowang commented Jun 25, 2018

Merge conflicts here. would you please do a rebase?

@eli-jordan
Copy link
Contributor Author

@kailuowang Done

@kailuowang kailuowang merged commit 2e781ae into typelevel:master Jun 26, 2018
@kailuowang kailuowang added this to the 1.2 milestone Jul 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants