Update contributors guide #2221
Conversation
This is the first draft of the updates suggested in typelevel#2139
CONTRIBUTING.md
Outdated
| > +2.11.12 | ||
| > compile | ||
| ``` | ||
| If you see errors in the compilation process related to the Scala version, you can execute the command `mimaReportBinaryIssues` to see what happened. |
There was a problem hiding this comment.
binary breaking changes won't necessarily cause compilation errors. So, instead of compile run mimaReportBinaryIssues should report the binary breaking issues.
Codecov Report
@@ Coverage Diff @@
## master #2221 +/- ##
=======================================
Coverage 95.05% 95.05%
=======================================
Files 333 333
Lines 5789 5789
Branches 211 211
=======================================
Hits 5503 5503
Misses 286 286Continue to review full report at Codecov.
|
CONTRIBUTING.md
Outdated
| @@ -115,15 +123,26 @@ builds: | |||
|
|
|||
| ### Write code | |||
|
|
|||
| TODO | |||
| Here are some suggestions for you while implementing your feature... | |||
There was a problem hiding this comment.
Type class is well documented in the typeclass.md, I'd say for now just remove the content of this section and provide a link to the https://typelevel.org/cats/guidelines.html
e.g.
[See guidelines](/cats/guidelines.html)
| repository you will push to. Ensure that this variable points to a | ||
| repo you wish to push to, and that it is one for which you have push | ||
| access, then run `sbt ghpagesPushSite` | ||
|
|
||
| ### Write examples |
There was a problem hiding this comment.
I guess we can write here:
One of the best ways to provide examples is doctest, here is an example of doctest examples in cats.
|
Thanks so much! I left some minor comments. |
|
Thank you @kailuowang! I'll address your observations this weekend. |
|
@kailuowang I've fixed the sections based on your comments. Please let me know if there's something else. Thanks! |
This is the first draft of the suggestions proposed by @kailuowang in #2139.
I have to say that I'm not entirely sure of the Write Code section, because I'm not totally familiar with some concepts mentioned in the related issues. So, if there are some mistakes, please help me identify them for fixing.
Thanks!