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

docs: improve and simplify changelog #1433

Merged
merged 2 commits into from
Apr 8, 2024

Conversation

ThomasFrans
Copy link
Contributor

Remove implementation details from the changelog as they are provided by the link in the version title for each release. Also rephrase some changes to make them more clear.

Describe your changes

  • Correctly add links at the bottom so the titles lead to the actual changes
  • Rephrase some stuff to make it more clear to non-developers
  • Remove implementation details (things a user wouldn't see in the program, documentation or the CLI for ncspot)

Issue ticket number and link

/

Checklist before requesting a review

  • Documentation was updated (i.e. due to changes in keybindings, commands, etc.)
  • Changelog was updated with relevant user-facing changes (eg. not dependency updates,
    not performance improvements, etc.)

Remove implementation details from the changelog as they are provided by
the link in the version title for each release. Also rephrase some
changes to make them more clear.
@ThomasFrans
Copy link
Contributor Author

This is not meant as a way to remove meaningful contributions from being shown to end users. The changelog should just not contain implementation details because non-developers don't care about those, despite how meaningful they are. If they are included, the changelog loses its entire purpose 🙂 (that's what the links to the commit history are for)

@hrkfdn hrkfdn enabled auto-merge (squash) April 8, 2024 07:49
@hrkfdn
Copy link
Owner

hrkfdn commented Apr 8, 2024

Merged, thanks!

@hrkfdn hrkfdn merged commit fe009d0 into hrkfdn:main Apr 8, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants