Closed leifdenby closed 3 years ago
cemac-ccs
commented
3 years ago This looks good to me. To be more informative it might be a good idea to explain areas that may affect running code, such as the changes made for arc compatibility which are designed to allow gnu >=7 compatibility (but are unfortunately incomplete). Do you want me to add this changelog in my PR, or wait for it to be pulled in to the trunk?
ralphburton
commented
3 years ago Seems like a great idea to me too. Thanks for suggesting it Leif. Cheers, Ralph
From: Chris Symonds @.> Sent: 05 May 2021 16:25 To: Leeds-MONC/monc @.> Cc: ralphburton @.>; Mention @.> Subject: Re: [Leeds-MONC/monc] add CHANGELOG (#49)
This looks good to me. To be more informative it might be a good idea to explain areas that may affect running code, such as the changes made for arc compatibility which are designed to allow gnu >=7 compatibility (but are unfortunately incomplete). Do you want me to add this changelog in my PR, or wait for it to be pulled in to the trunk?
— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHubhttps://github.com/Leeds-MONC/monc/pull/49#issuecomment-832780497, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ARDBWWI36LDM3J6F6VW7METTMFPN3ANCNFSM44CQJOPA.
leifdenby
commented
3 years ago just spoke to @sjboeing and he's happy with this too, so I'm going to merge. Hurray for having a changelog from now on!
I've been thinking about how we can keep an up-to-date changelog for MONC, and here's my suggestion (modelling this on xarray's "whats-new.rst" file):
Once a pull-request has reached the final stages where we're happy for it to be merged the author of the pull-request should add a line to CHANGELOG.md in the "unreleased" section with one sentence summarising the change. This section will be split into at least "new features" and "bug fixes" subsections, and if the pull-request introduces a breaking change into should be a separate "breaking changes" subsection.
Sound ok @sjboeing, @cemac-ccs, @MarkUoLeeds, @ralphburton, @eers1?
We've already got a few changes since v0.9.0 (where we forked from MOSRS) so I think we should get this CHANGELOG added before we make any more additions/changes (e.g. #48, #47, #46)
Please check if you're happy with the format and what I've pull in the CHANGELOG so far: https://github.com/leifdenby/monc/blob/add-changelog/CHANGELOG.md (@sjboeing and @cemac-ccs in particular)