jsr354-api icon indicating copy to clipboard operation
jsr354-api copied to clipboard

Update release notes in README

Open keilw opened this issue 6 years ago • 7 comments

The README file mentions 1.0.1 only, newer releases should be mentioned there or in a separate file.

keilw avatar Apr 15 '18 22:04 keilw

Why not just to remove the releases section from README and use this one instead https://github.com/JavaMoney/jsr354-api/releases ? The only problem I see is that thus we get vendor locking with GitHub and for those who will fork the project wont see the changelog. But in the same time this is more convenient

stokito avatar Nov 12 '18 05:11 stokito

Sounds like a good idea, but I'm not sure, if a separate page makes sense? We do have an API page on the main site: http://javamoney.github.io/api.html (a little outdated btw.) There is a gh-pages branch in this repo, but it seems fairly outdated and I can't even see the URL working.

keilw avatar Nov 12 '18 13:11 keilw

It's ok to create a CHANGELOG file just in sources instead of github pages/wiki. But it still don't have a lot sense for me.

stokito avatar Nov 12 '18 13:11 stokito

I wouldn't use the Wiki because it has no versioning, but a CHANGELOG file sounds OK.

keilw avatar Nov 12 '18 13:11 keilw

I guess it should be something similar to https://github.com/eclipse/jetty.project/blob/jetty-9.4.x/VERSION.txt in the Jetty project. Plain text or MD that I assume we are flexible.

keilw avatar Nov 15 '18 15:11 keilw

I would prefer adoc. It is very similar to md, GitHub renders it and it is much more powerful. But that's an implementation detail…

McPringle avatar Nov 15 '18 16:11 McPringle

@McPringle @stokito Could either of you propose a PR? ADoc sounds fine, the Spec is already using it.

keilw avatar Nov 15 '18 16:11 keilw