Changelogs

[coot]

The consensus & network teams maintain interface-CHANGELOG (and here). These are tailored for downstream components, which allows us to skip changes which are not relevant for them.

For packages that are standalone libraries and used more widely this is not a good choice (and maybe it's not even good choice for the network & consensus anymore), e.g. things like cardano-prelude or packages which will land on Hackage.

[michaelpj]

The handbook already recommends that you should have a CHANGELOG or one per package: https://input-output-hk.github.io/cardano-engineering-handbook/policy/project/index.html#recommended-documents

It doesn't say anything about what goes in there, I'm somewhat happy to leave that to individual projects to decide, what do you think?

[coot]

I would put extra requirements for projects that are published on Hackage, for internal projects I think it's indeed better to leave things fluid.

[michaelpj]

#33

[michaelpj]

That said, we could totally have a "Practices" section on CHANGELOGS, especially if we have some good examples.