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

Update release notes in README #74

Open
keilw opened this issue Apr 15, 2018 · 7 comments
Open

Update release notes in README #74

keilw opened this issue Apr 15, 2018 · 7 comments
Labels
Milestone

Comments

@keilw
Copy link
Member

keilw commented Apr 15, 2018

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

@keilw keilw added the task label Apr 15, 2018
@keilw keilw added this to the 1.0.4 milestone Jul 15, 2018
@stokito
Copy link
Member

stokito commented Nov 12, 2018

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

@keilw
Copy link
Member Author

keilw commented Nov 12, 2018

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.

@stokito
Copy link
Member

stokito commented Nov 12, 2018

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.

@keilw
Copy link
Member Author

keilw commented Nov 12, 2018

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

@keilw
Copy link
Member Author

keilw commented Nov 15, 2018

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.

@McPringle
Copy link
Contributor

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…

@keilw
Copy link
Member Author

keilw commented Nov 15, 2018

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

@keilw keilw modified the milestones: 1.1, .Next Dec 10, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants