shiblon / entroq

Competing-consumer fault-tolerant task queues. Written in Go.
Apache License 2.0
22 stars 4 forks source link

Keep a Changelog #28

Open ghost opened 3 years ago

ghost commented 3 years ago

Issue

No information on the difference between version

Why

To make it easier for users and contributors to see precisely what notable changes have been made between each release (or version) of the project.

Example

https://keepachangelog.com/en/1.0.0/

shiblon commented 1 year ago

Very good idea. Added CHANGES.md to the root directory in 745d4594492e214b0ef44cec9d741d055cc74ffd. Format probably not ideal, but we can iterate. Suggestions welcome.

deardooley commented 1 year ago

Could this be updated to CHANGELOG.md to fall into compliance and perhaps work with some automation tools like agaveplatform/changelog-parser:latest?

— Rion

On Jun 28, 2023, at 9:40 AM, Chris Monson @.**@.>> wrote:

Very good idea. Added CHANGES.md to the root directory in 745d459https://github.com/shiblon/entroq/commit/745d4594492e214b0ef44cec9d741d055cc74ffd. Format probably not ideal, but we can iterate. Suggestions welcome.

— Reply to this email directly, view it on GitHubhttps://github.com/shiblon/entroq/issues/28#issuecomment-1611435683, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAF7WMTK4CRG6ZJM4YKSA5LXNQX6FANCNFSM42JJD2HA. You are receiving this because you are subscribed to this thread.Message ID: @.***>

shiblon commented 1 year ago

Sure! What format should we use for its contents? Do you want to take a stab at it, or just explain it to me so I can?

deardooley commented 1 year ago

https://keepachangelog.com/en/1.0.0/ has a pretty solid format laid out.

— Rion

On Jun 30, 2023, at 7:49 AM, Chris Monson @.**@.>> wrote:

Sure! What format should we use for its contents? Do you want to take a stab at it, or just explain it to me so I can?

— Reply to this email directly, view it on GitHubhttps://github.com/shiblon/entroq/issues/28#issuecomment-1614605164, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AAF7WMSYJJG2XXEMHFHBTVLXN3DMZANCNFSM42JJD2HA. You are receiving this because you commented.Message ID: @.***>