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

RELNOTES: dedup/reword/sort/add #5377

Merged
merged 4 commits into from
Sep 26, 2022

Conversation

kmk3
Copy link
Collaborator

@kmk3 kmk3 commented Sep 19, 2022

$ git log --reverse --pretty='* %s' master..
* README.md: remove items duplicated from RELNOTES
* RELNOTES: reword modif items for clarity
* RELNOTES: sort items by category then date added
* RELNOTES: add docs

Added on commit 6d740d7 ("RELNOTES and README.md - existing
functionality modified for the next version", 2022-08-29).

The duplication makes it harder to maintain the RELNOTES, especially
because the contents are prone to diverge between each file.

For example, even though the commit in question (6d740d7) added the
same items to both files, the additions to RELNOTES had two typos, while
the additions to README.md had one typo.

The typos in RELNOTES were fixed by commit c5e8d5d ("typo fixes for
RELNOTES", 2022-08-29), and the typo in README.md was fixed by commit
2ac8a93 ("typo fix for README.md", 2022-08-29), both from PR netblue30#5349.
And add the missing issue/PR references.

Misc: The items in question were added on commit 6d740d7 ("RELNOTES
and README.md - existing functionality modified for the next version",
2022-08-29).

Relates to netblue30#5190 netblue30#5196 netblue30#5200 netblue30#5209 netblue30#5216.
Put features before modifs, to match the relnotes of 0.9.68 and
0.9.70.
@kmk3 kmk3 requested review from glitsj16 and netblue30 September 19, 2022 18:58
@kmk3
Copy link
Collaborator Author

kmk3 commented Sep 19, 2022

From commit dfc5593 ("README.md: remove items duplicated from RELNOTES",
2022-09-17):

README.md: remove items duplicated from RELNOTES

Added on commit 6d740d7 ("RELNOTES and README.md - existing
functionality modified for the next version", 2022-08-29).

The duplication makes it harder to maintain the RELNOTES, especially
because the contents are prone to diverge between each file.

For example, even though the commit in question (6d740d7) added the
same items to both files, the additions to RELNOTES had two typos, while
the additions to README.md had one typo.

The typos in RELNOTES were fixed by commit c5e8d5d ("typo fixes for
RELNOTES", 2022-08-29), and the typo in README.md was fixed by commit
2ac8a93 ("typo fix for README.md", 2022-08-29), both from PR #5349.

How about adding a link to the RELNOTES on README.md? Example:

For more details about the changes in the upcoming release, see
[RELNOTES](RELNOTES).

By the way, the modif items themselves that were added to the RELNOTES were
good; I wasn't sure about the best way to list them since they all relate to
the same issue (#5190) and because it wasn't immediately obvious the extent of
the changes done on #5190.

Copy link
Collaborator

@glitsj16 glitsj16 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@netblue30 netblue30 merged commit 1cc9cf9 into netblue30:master Sep 26, 2022
@netblue30
Copy link
Owner

merged!

@kmk3 kmk3 deleted the relnotes-dedup-reword-sort-add branch September 26, 2022 19:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done (RELNOTES N/A)
Development

Successfully merging this pull request may close these issues.

4 participants