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.

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

release regex-capi 1.0 #574

Open
davidblewett opened this issue Apr 8, 2019 · 3 comments
Open

release regex-capi 1.0 #574

davidblewett opened this issue Apr 8, 2019 · 3 comments

Comments

@davidblewett
Copy link
Contributor

The 1.0 version of regex was released just shy of a year ago: #457 . I would like to stabilize the rure-python bindings at 1.0.

You mentioned doing an audit of the API; is there something I can assist with?

@BurntSushi
Copy link
Member

I think the audit is something like this:

  • Looking at the issue tracker for anything related to regex-capi. (There isn't much, I don't think.)
  • Carefully review the public API documented in rure.h along with the implementation. In particular, does the documentation of relevant contracts match the implementation?
  • Scan the rure source code for any relevant TODOs.
  • Think holistically about whether the API is right or not.

My guess is that the existing API can be marked as 1.0 without any changes. But the above process is a sanity check before committing to a 1.0. While it's true that a 2.0 can always be released to fix things, I generally like to treat 1.0 as some kind of commitment to stability measured at the level of ~years.

@davidblewett
Copy link
Contributor Author

@BurntSushi is this something you would like me to help with? I can probably help with 1-3; not sure about 4.

@BurntSushi
Copy link
Member

Honestly, it's probably something I'd want to at least do myself. It's hard to farm out this kind of work unfortunately. Of course, having folks go through the above steps in addition to me would be very helpful since additional perspectives are great for this kind of stuff, especially from someone who is actually using it. :-)

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

No branches or pull requests

2 participants