search

uber-go / cadence-client

Framework for authoring workflows and activities running on top of the Cadence orchestration engine.
https://cadenceworkflow.io
MIT License
344 stars 130 forks source link

Keep a Changelog for the Cadence Client? #652

Open hlin117 opened 5 years ago

hlin117 commented 5 years ago

Hey all! I'm happy to see Cadence-Client is actively maintained.

It seems the Cadence-Client undergoes code changes pretty frequently. Can we keep a Changelog to document what changes are available version to version?

dmetzgar commented 5 years ago

We put all the changes along with the releases. If that doesn't work, could you provide an example of how we could do this better?

hlin117 commented 5 years ago

Oh I didn't see that! Thank you for linking me.

As for whether Github release notes or the Changelog format is more standard, I'm not quite the one to say. However, from what I understand from other Uber open source projects like yarpc-go, thriftrw-go, zap, and the like, the Changelog format seems recommended.

dmetzgar commented 5 years ago

In the thrift changelog, it links to keep a changelog which is pretty informative. I'll have a look.