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

doc: changelog.md updates #6411

Merged
merged 2 commits into from
Sep 14, 2021

Conversation

Totktonada
Copy link
Member

  • Fixed a typo in a link anchor.
  • Added an alternative process (to better highlight why we stick with our one).

@coveralls
Copy link

coveralls commented Sep 2, 2021

Coverage Status

Coverage increased (+0.002%) to 84.215% when pulling 70fdac3 on Totktonada/fix-a-link-in-changelogs-md-notest into b0431cf on master.

Copy link
Collaborator

@igormunkin igormunkin left a comment

Choose a reason for hiding this comment

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

@Totktonada, thanks for the changes! LGTM since they are trivial.

Side note: I believe we can fix errors and typos, when building the final version of the changelog at the moment git tag is set, but yes, our approach is more flexible and convenient (at least for me).

@Totktonada Totktonada force-pushed the Totktonada/fix-a-link-in-changelogs-md-notest branch from f8793a1 to 708a5d6 Compare September 8, 2021 23:41
@Totktonada
Copy link
Member Author

  • Renamed 'Alternatives' to 'Alternatives considered'.
  • Added the explicit list of considered alternatives (reasons 'why not' are still in the 'Reasoning' section).
  • Highlighted the problems we would have without ability to modify a changelog entry at any time (the scenario is suggested by @kyukhin).
  • In the commit message:
    • Replaced 'a possible alternative' with 'a declined alternative'.
    • Added 'that' for grammar.
  • Rebased on current master.

doc/changelogs.md Show resolved Hide resolved
doc/changelogs.md Outdated Show resolved Hide resolved
doc/changelogs.md Outdated Show resolved Hide resolved
doc/changelogs.md Show resolved Hide resolved
doc/changelogs.md Outdated Show resolved Hide resolved
@Totktonada Totktonada force-pushed the Totktonada/fix-a-link-in-changelogs-md-notest branch from 708a5d6 to f054b48 Compare September 12, 2021 14:11
I think that our current process is better. But if someone will want to
understand why we stick with it, it is good to have explicit cons and
pros.
@Totktonada Totktonada force-pushed the Totktonada/fix-a-link-in-changelogs-md-notest branch from f054b48 to 70fdac3 Compare September 14, 2021 09:11
@Totktonada Totktonada merged commit 8461d67 into master Sep 14, 2021
@Totktonada Totktonada deleted the Totktonada/fix-a-link-in-changelogs-md-notest branch September 14, 2021 11:53
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

Successfully merging this pull request may close these issues.

4 participants