gtank / ristretto255

Implements ristretto255, a fast prime-order group.
https://ristretto.group
BSD 3-Clause "New" or "Revised" License
98 stars 22 forks source link

Package status #25

Closed hdevalence closed 5 years ago

hdevalence commented 5 years ago

I don't know what the convention is in Go, since there aren't package files with semver strings, but: what's the status of this package? Should we tell people that it's considered stable? Is there a way to mark a "1.0 release"?

hdevalence commented 5 years ago

cc @gtank @FiloSottile

FiloSottile commented 5 years ago

If we make a v1.0.0 tag, we are committing to making no API breaking changes without bumping to github.com/gtank/ristretto255/v2. I'm not sure we've seen enough usage to make that step.

hdevalence commented 5 years ago

That's totally reasonable -- is there a way to signal that, beyond the possibility of breaking API changes, the package is mostly finished, and that people should try using it?

FiloSottile commented 5 years ago

We can make a v0.1.0 tag. That, along with good docs and no "don't use this" warnings, should do.

Want me to go ahead and make one? @gtank?

hdevalence commented 5 years ago

That sounds great. Is there any doc work that needs doing before that happens? I'm happy to help, but I'd like to get this project over some arbitrarily-defined finish line :)

FiloSottile commented 5 years ago

Not that I can tell, I curated the godocs as we went along.

https://godoc.org/github.com/gtank/ristretto255

I'll make the tag.

FiloSottile commented 5 years ago

Done!