You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
NOTES in this project became simply a subset of CHANGELOG.
Since #541, changelog updates are handled by towncrier. Towncrier builds new fragments only into CHANGELOG file. Meaning that release manager will either manually have to go through updates and select which changes to copy-paste from produced CHANGELOG into NOTES, or contributors will need to manually update NOTES for issues/PRs where it is applicable (basically same way as it was handled before towncrier was introduced). Both options seem like an unnecessary complication to the contribution and release process, so NOTES could be removed from the project altogether.
Before it is done, some entries need to be manually moved from NOTES to CHANGELOG. This is because in the following PRs for some reason I have only updated the NOTES file (which further proves that keeping both files can easily lead to confusion when contributing):
I don't think we need to remove NOTES entirely. It's just that we're not using it for the correct purpose in its current incarnation. IMO, the NOTES file should really only consist of actual notes to end users about things they need to make note of when upgrading the Argus frontend. An example could be:
# [vX.Y.Z] - 2042-01-12
- Ensure that the new environment variable `FOOBAR` is set, or the program will not run.
If we have none of those, then yes, we could remove the NOTES file and re-introduce it when the need arises.
NOTES
in this project became simply a subset ofCHANGELOG
.Since #541, changelog updates are handled by towncrier. Towncrier builds new fragments only into
CHANGELOG
file. Meaning that release manager will either manually have to go through updates and select which changes to copy-paste from producedCHANGELOG
intoNOTES
, or contributors will need to manually updateNOTES
for issues/PRs where it is applicable (basically same way as it was handled before towncrier was introduced). Both options seem like an unnecessary complication to the contribution and release process, soNOTES
could be removed from the project altogether.Before it is done, some entries need to be manually moved from
NOTES
toCHANGELOG
. This is because in the following PRs for some reason I have only updated theNOTES
file (which further proves that keeping both files can easily lead to confusion when contributing):The text was updated successfully, but these errors were encountered: