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.

Sign up for GitHub

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

Jump to bottom

Update CONTRIBUTING.md #2139

Closed
6 tasks
kailuowang opened this issue Jan 4, 2018 · 5 comments
Closed
6 tasks

Update CONTRIBUTING.md #2139

kailuowang opened this issue Jan 4, 2018 · 5 comments
Labels
documentation help wanted low-hanging fruit

Comments

@kailuowang
Copy link
Contributor

kailuowang commented Jan 4, 2018 •
edited
Loading

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

@kailuowang Can I take this?

@kailuowang
Copy link
Contributor Author

of course. @AlejandroME Thanks!

@Rlucas12
Copy link

Rlucas12 commented Apr 5, 2018

Is this done ?

@AlejandroME
Copy link
Contributor

@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
d6adf09 
This is the first draft of the updates suggested in typelevel#2139
@AlejandroME AlejandroME mentioned this issue Apr 5, 2018
Merged
kailuowang pushed a commit that referenced this issue Apr 9, 2018
@AlejandroME @kailuowang
Update contributors guide (#2221)
3ac3ba1 
* 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.
@kubukoz
Copy link
Member

kubukoz commented May 26, 2018

Can this be closed? @AlejandroME @kailuowang

@LukaJCB LukaJCB closed this as completed May 26, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation help wanted low-hanging fruit
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@kailuowang @kubukoz @AlejandroME @LukaJCB @Rlucas12