libelektra icon indicating copy to clipboard operation
libelektra copied to clipboard

restructure release notes to be more useful for 1.0

Open markus2330 opened this issue 4 years ago • 3 comments

@mpranj we already talked about it but we didn't get to a conclusion yet. How do we want to assemble the 1.0 release notes? As starting writing the 1.0 release notes already now is probably unrealistic, what about having sections in every release that will be copied to the 1.0 release notes? I am mainly thinking about highlights and breaking change but maybe we can restructure the release notes to make it even more suitable for that task?

markus2330 avatar Jul 20 '21 13:07 markus2330

Copying&rewording from the highlights should be quite easy.

The breaking changes are more problematic, as it is possible that we already did not mention some subtle breaking changes. It sounds like we could benefit from adding a breaking changes section so that it is easier to copy to 1.0 later.

mpranj avatar Jul 24 '21 18:07 mpranj

Yes, I agree! Let us add a "breaking changes" section to every release from now on that summarizes what will be relevant for the 1.0 release. :rocket:

markus2330 avatar Jul 25 '21 07:07 markus2330

I mark this issue stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping the issue by writing a message here or create a new issue with the remainder of this issue. Thank you for your contributions :sparkling_heart:

stale[bot] avatar Jul 30 '22 20:07 stale[bot]

I closed this issue now because it has been inactive for more than one year. If I closed it by mistake, please do not hesitate to reopen it or create a new issue with the remainder of this issue. Thank you for your contributions :sparkling_heart:

stale[bot] avatar Sep 28 '22 03:09 stale[bot]