Conversation
|
Here's a draft of some release notes for our next release. I took the output of git-cliff and then edited extensively. Hopefully as we following conventional commits more going forward there will be less edited needed. There's probably more work needed on the git-cliff config and the changes to CONTRIBUTING.md. I may merge those separately. Also, somewhat relatedly, I've disabled rebasing on the repo, so now the only option is to squash. I documented the motivation for this in CONTRIBUTING.md, but I'm open to discussion on this if anyone feels strongly. I've also set the default commit message for squashes to be the PR description. We had quite a few commits where the commit message was a list of the commits that got squashed, which in some cases is a bit noisy, especially when there's lot of fixups, so I thought we could have a try at using the PR description and see how that goes. In either case, it can be edited when squashing. Anyway, what do you think of the groupings in the release notes? Any extra headings we should add (or remove)? I was unsure about porting. RISC-V work is kind of porting, but I guess I classified early-stage-porting as porting and later stage as just bug fixing. I did wonder if we should have separate headings for platform-specific work. e.g. a RISC-V heading, but then I realised that there's a lot of testing changes that were RISC-V specific and I wasn't sure if they would then go under RISC-V or under testing. |
CONTRIBUTING.md
Outdated
| When we write the release notes, we try to categorise commits into groups. You can help by prefixing | ||
| the commit title with a word that gives a clue as to which section it should go in. If you think it | ||
| shouldn't go in the release notes, you can prefix the title with "chore:" or "typo:", neither of | ||
| which get included in the notes. |
There was a problem hiding this comment.
We could also filter by footer changelog: skip like in 921fa4b but that's up to you. Example of git-cliff config: https://github.com/davidlattimore/wild/pull/1256/files#diff-e1372c8b03c40942b5d828a90975054cb8aaed3b38189f434396f922ec41a584R90
I view it the same way. Porting for me is creating the foundation, once something mostly works, it's no longer a porting work. |
marxin
left a comment
There was a problem hiding this comment.
I've just read the newly formatted ChangeLog and I'm really enjoying the new format - it makes it much more structured and easier to consume. Moreover, it's sorted from the most important news, to the least important. Good job!
Plus, I'm really impressed by the number of the changes that have been made since the latest release. What a nice surprise.
77fb925 to
495af2a
Compare
No description provided.