lloydmeta / frunk

Funktional generic type-level programming in Rust: HList, Coproduct, Generic, LabelledGeneric, Validated, Monoid and friends.
https://beachape.com/frunk/
MIT License
1.29k stars 58 forks source link

Beginning the changelog #120

Closed ExpHP closed 6 years ago

ExpHP commented 6 years ago

I like @Centril's idea of following https://keepachangelog.com/en/1.0.0/

Note: To follow it 100%, there are a good 38 versions that need to be retroactively documented; that seems like a pretty big chore! I'm tempted to say to just start at 0.2.0 with a list of everything frunk currently has to offer.

Centril commented 6 years ago

Oh; I didn't know that you're supposed to document all versions 😄.

I super agree that we should start with 0.2.0 ;)

lloydmeta commented 6 years ago

Agreed. Definitely let's start with 0.2.0 😆

Centril commented 6 years ago

Btw... does starting with 0.2.0 mean that the changelog should include all the things that are in 0.2.0 or just that versions > 0.2.0 are documented in the changelog?

ExpHP commented 6 years ago

include all the things that are in 0.2.0

this one. It's what the example on the keepachangelog page does. You can also see rust did it here

ExpHP commented 6 years ago

By the way, I'm not sure how to handle the separate subcrates. (since there will be times when not all of them need a version bump)


(I just went to go see what num does: they haven't kept good track either :stuck_out_tongue: )

ExpHP commented 6 years ago

We could also just plop down a stub changelog so that we at least have an [Unreleased] section that we can update for now

Centril commented 6 years ago

@ExpHP Ah; Since you did most of the work on 0.2.0, would you like to take charge of writing the changelog?

Wrt. the subcrates, I think that if we only bump a single subcrate, then it makes sense to say which subcrate the release is for. Otherwise, it is probably best to talk about them as one monolithic frunk. It should hopefully be clear from the documentation which crate things applies to, and we also have re-exports.

👍 on Unreleased for now.

ExpHP commented 6 years ago

Closed by #121