Skip to content
This repository has been archived by the owner on Feb 8, 2022. It is now read-only.

Add 0.5.0 release to readme and do some cleanup. #162

Merged
merged 2 commits into from
Sep 2, 2016
Merged

Conversation

non
Copy link
Contributor

@non non commented Aug 31, 2016

I just pushed 0.5.0 to Sonatype, so this PR will update the version in our README.

I also linkified the contributor names, rephrased some paragraphs, and added some code blocks to other parts of the README.

I think 0.5.0 should be a candidate for where we start our MiMA compatibility requirements. Here's my proposal for what happens next:

  1. @non, @tixxit, @rklaehn, and others will get a Spire branch working that uses algebra-0.5.0.
  2. We test that Spire branch to be sure that we don't see major problems with our benchmarks.
  3. @johnynek and others optionally do the same thing for Algebird.
  4. If needed, we make changes to cats-kernel and algebra, re-release, goto (1).
  5. We all agree that we are happy with cats-kernel and algebra in their current form.
  6. We freeze cats-kernel in MiMA compatibility mode.
  7. We freeze algebra in MiMA compatibility mode (and call it 1.0.0).
  8. Profit!

(In the meantime we can merge PRs but should aim to keep MiMA compatibility with 0.5.0 unless we notice a serious design flaw that we have to fix.)

What do you all think?

@tixxit
Copy link
Contributor

tixxit commented Aug 31, 2016

This all sounds great to me. And the PR looks good too 👍

@non
Copy link
Contributor Author

non commented Aug 31, 2016

One other possible change we might want to do pre-freeze is to make our law definitions consistent with Cats'. I think that style is a bit easier to read/understand (since it came later). That idea is tracked at typelevel/cats#1272.

I don't think it's mandatory that cats-kernel and cats have exactly the same type of law definitions, but I don't see a good reason to prefer our current scheme.

@non non merged commit 6bfd3c1 into master Sep 2, 2016

libraryDependencies += "org.spire-math" %% "algebra" % "0.4.0"
```scala
libraryDependencies += "org.spire-math" %% "algebra" % "0.5.0"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This now needs to be org.typelevel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I'll put this in a PR asap.

@larsrh larsrh deleted the topic/readme-050 branch February 13, 2019 18:19
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants