search

serpapi / turbo_tests

Run RSpec tests on multiple cores. Like parallel_tests but with incremental summarized output. Originally extracted from the Discourse and Rubygems source code.
https://rubygems.org/gems/turbo_tests
MIT License
173 stars 25 forks source link

Add Changelog #11

Open westonganger opened 3 years ago

westonganger commented 3 years ago

Please add a changelog so we can see whats changed between versions.

ilyazub commented 3 years ago

Agree. Currently, GitHub Releases page can be used as a changelog.

I'll add a changelog based on Keep a Changelog format. In the future, I'd rather automate this stuff with github-changelog-generator or release-drafter. What do you think?

aprescott commented 1 month ago

Since I just ran into this, trying to determine what was included in a release: I personally find a changelog file separate from GitHub releases notes to be very helpful.

That said, no matter where the changelog is made available, I would ask as an outside dev that the changelog explicitly not be generated from commits or merged PRs. A log of git activity is very different from the higher-level document I'd expect when reading a changelog.

The github-changelog-generator project linked above mentions keepachangelog.com, which also outlines this same guidance:

Changelogs are for humans, not machines.

https://keepachangelog.com/en/1.1.0/#bad-practices:

Commit log diffs Using commit log diffs as changelogs is a bad idea: they're full of noise. Things like merge commits, commits with obscure titles, documentation changes, etc.

The purpose of a commit is to document a step in the evolution of the source code. Some projects clean up commits, some don't.

The purpose of a changelog entry is to document the noteworthy difference, often across multiple commits, to communicate them clearly to end users.