Remove alpha banner - Githubissues

jkcfg / jk

Configuration as Code with ECMAScript

https://jkcfg.github.io

Apache License 2.0

406 stars 30 forks source link

Remove alpha banner #314

Closed danielepolencic closed 4 years ago

danielepolencic commented 4 years ago

Context: this issue originated from this thread.

You should consider removing the "alpha banner":

jk is still in very early stages. The standard library API isn't frozen and will most likely change. Feedback is most definitely welcome!

I understand that the API is in flux, but it's hard to promote the tool if the first thing you see is a warning suggesting that this is not ready for prime time.

dlespiau commented 4 years ago

That rings completely true :) Instead maybe we should document in the README somewhere the API guarantees before we reach 1.0.0, ie.

There is no incompatibilities between patch versions: for a fixed x all 0.x.y versions are compatible.
Minor versions may introduce some API changes. Those changes are documented in deprecations.md.