bebop / poly

A Go package for engineering organisms.
https://pkg.go.dev/github.com/bebop/poly
MIT License
663 stars 70 forks source link

This project should have a `CHANGELOG.md` #369

Closed carreter closed 10 months ago

carreter commented 10 months ago

Is your feature request related to a problem? Please describe. We currently do not have a way of keeping track of what is changing from release to release. This will become especially important once we release v1.0, as clients will start depending on functionality being stable and breaking changes to our API should be well documented.

Describe the solution you'd like https://keepachangelog.com/en/1.1.0/

Describe alternatives you've considered N/A

Additional context N/A

TimothyStiles commented 10 months ago

Closest thing that we have to a change log right now is the on that's generated for each release.

Usually I make a big BREAKING CHANGES header for what's going on but something a little more refined could be good.

On Sat, Sep 23, 2023, 2:22 PM Willow Carretero Chavez < @.***> wrote:

Is your feature request related to a problem? Please describe. We currently do not have a way of keeping track of what is changing from release to release. This will become especially important once we release v1.0, as clients will start depending on functionality being stable and breaking changes to our API should be well documented.

Describe the solution you'd like https://keepachangelog.com/en/1.1.0/

Describe alternatives you've considered N/A

Additional context N/A

— Reply to this email directly, view it on GitHub https://github.com/TimothyStiles/poly/issues/369, or unsubscribe https://github.com/notifications/unsubscribe-auth/ABVXJVFWG3EJESSU7UUCC7LX35HHVANCNFSM6AAAAAA5EOI4VA . You are receiving this because you are subscribed to this thread.Message ID: @.***>