search

ScratchAddons / website-v2

The website for Scratch Addons. (version 2)
https://scratchaddons.com
GNU General Public License v3.0
51 stars 39 forks source link

Thank contributors in the changelog #387

Open DNin01 opened 1 year ago

DNin01 commented 1 year ago

It's nice to give back to the people who helped us build Scratch Addons, through mentions. Products like PowerToys mention contributors in its release notes. We could start thanking people in the next changelog entries, and @lisa-wolfgang's v1.30 blog post gave credits!

One question worth asking is who should be credited in pull requests with multiple committers?

Hans5958 commented 1 year ago

cc @WorldLanguages (or whoever manages the release notes)

WorldLanguages commented 1 year ago

I'm not sure if this would fit in the itemized changelog, which is already quite long and hard to read... It would be nice to thank contributors in the blog posts though

Hans5958 commented 1 year ago

I would say to improve our changelog to a proper notes, though on second thought, our blog posts are technically the release notes...

WorldLanguages commented 1 year ago

I would say to improve our changelog to a proper notes

Maybe we could improve the "itemized changelog" by providing a way to "extend" the most important items of each new release to get more details. For example, extending a New addon: XYZ item would tell you more about the addon. Credits could also be listed there I guess. Clicking over bug fixes that are hard to explain to end-users would allow anyone to know which issue/ PR the bug fix is referring to, to get more details. And again credits could be added there.

Not sure if this is worth it, though.

Hans5958 commented 1 year ago

There should be a clear distinction between the changelog, which ideally should include all changes (not just notable), and the release notes, which is a summary of changes and can be published as a blog post.

That being said, Something like "we like to thank the new contributors like..." would be bettar as a release notes on the blog, but although something small as "thanks @Hans5958!" is still fine on the changelog.