Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove NOTES.md #559

Open
podliashanyk opened this issue Apr 19, 2024 · 2 comments
Open

Remove NOTES.md #559

podliashanyk opened this issue Apr 19, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@podliashanyk
Copy link
Contributor

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):

@podliashanyk podliashanyk added documentation Improvements or additions to documentation priority: high rc-next Strong candidate for frontend's next release labels Apr 19, 2024
@lunkwill42
Copy link
Member

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.

@podliashanyk
Copy link
Contributor Author

Since #563 is merged, this issue is not an urgent one anymore

@podliashanyk podliashanyk removed the rc-next Strong candidate for frontend's next release label Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants