/cats

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

Update CONTRIBUTING.md #2139

Closed
kailuowang opened this Issue Jan 4, 2018 · 5 comments

Comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
No milestone
5 participants
@kailuowang @AlejandroME @Rlucas12 @kubukoz @LukaJCB
@kailuowang
Member

kailuowang commented Jan 4, 2018 •
edited

  • In the write test section, link to https://typelevel.org/cats/typeclasses/lawtesting.html
  • add a step of checking binary compatible: ++2.11.12 and then mimaReportBinaryIssues
  • in the write code section, copy/consolidate the discussion from the linked issues to Guidelines.md and then link to it.
  • remove the "Publishing the site to github" section, this is done by sbt-microsite now.
  • The doc suggested to use the Waffle.io to find issues to work on, should replace with finding issue with the low-hanging-fruit or help-wanted tag
  • in the what goes in cats section also introduce mouse, cats-effect and cats-mtl
    Not sure if I captured all the outdated bits. But these should be make it by and large update-to-date.

@kailuowang kailuowang added documentation help wanted low-hanging fruit labels Jan 4, 2018

@AlejandroME

This comment has been minimized.

Sign in to view
Contributor

AlejandroME commented Mar 19, 2018

@kailuowang Can I take this?
@kailuowang

This comment has been minimized.

Sign in to view
Member

kailuowang commented Mar 19, 2018

of course. @AlejandroME Thanks!
@Rlucas12

This comment has been minimized.

Sign in to view

Rlucas12 commented Apr 5, 2018

Is this done ?
@AlejandroME

This comment has been minimized.

Sign in to view
Contributor

AlejandroME commented Apr 5, 2018

@Rlucas12 WIP, pushing the first draft between today and tomorrow.

AlejandroME added a commit to AlejandroME/cats that referenced this issue Apr 5, 2018

@AlejandroME
First draft for updating the contribs guide 
This is the first draft of the updates suggested in typelevel#2139
d6adf09

@AlejandroME AlejandroME referenced this issue Apr 5, 2018

Merged

Update contributors guide #2221

kailuowang added a commit that referenced this issue Apr 9, 2018

@AlejandroME @kailuowang
Update contributors guide (#2221) 
* WIP

* First draft for updating the contribs guide

This is the first draft of the updates suggested in #2139

* Fixed sections based on @kailuowang suggestions.
3ac3ba1
@kubukoz

This comment has been minimized.

Sign in to view
Contributor

kubukoz commented May 26, 2018

Can this be closed? @AlejandroME @kailuowang

@LukaJCB LukaJCB closed this May 26, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment