search

willowtreeapps / sign-in-with-apple-button-android

An Android library for Sign In with Apple
MIT License
283 stars 68 forks source link

Add a Changelog.md file, and fill GitHub releases #47

Open LouisCAD opened 5 years ago

LouisCAD commented 5 years ago

This is needed to know what has changed from release 0.1 and 0.2, and upcoming releases. Thank you!

kconner commented 5 years ago

To express changes per version, we've so far relied on git features like tags, rather than GitHub-specific features like Releases. At the moment, the releases page will show the changes for each version if you reveal the tag comment ("…") or click through to the tag's page.

Upcoming versions would be a good reason to use Releases, but in this project's case, upcoming versions are not planned so much as cut when we're satisfied with the state of develop.

But of course I'm not visiting this project as a newcomer, so I may miss the point. Can you say more about the benefit you would get from our maintaining a changelog someplace other than in tags?

LouisCAD commented 5 years ago

The changelog files is GitHub independent and allows to glance at changes, and makes them searchable.

On Mon, Aug 12, 2019, 15:25 Kevin Conner notifications@github.com wrote:

To express changes per version, we've so far relied on git features like tags, rather than GitHub-specific features like Releases. At the moment, the releases page https://github.com/willowtreeapps/sign-in-with-apple-button-android/releases will show the changes for each version if you reveal the tag comment ("…"). (I should add details to 0.1's comment; it's empty at the moment.)

Upcoming versions would be a good reason to use Releases, but in this project's case, upcoming versions are not planned so much as cut when we're satisfied with the state of develop.

But of course I'm not visiting this project as a newcomer. Can you say more about the benefit you would get from our maintaining a changelog someplace other than in tags?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/willowtreeapps/sign-in-with-apple-button-android/issues/47?email_source=notifications&email_token=ABVG6BJGV7BBZ35BHKAE4RTQEFQDLA5CNFSM4IK7GY2KYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4CQPZY#issuecomment-520423399, or mute the thread https://github.com/notifications/unsubscribe-auth/ABVG6BNNYPY2OCAYKRSV7HTQEFQDLANCNFSM4IK7GY2A .

kconner commented 5 years ago

I do like ease for the reader, as in glanceability. OK, I think we'll add that file.

evant commented 5 years ago

Am a fan of https://keepachangelog.com/en/1.0.0/, using that format on assertk