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

Thank contributors in the changelog #387

Open
DNin01 opened this issue Sep 30, 2023 · 5 comments
Open

Thank contributors in the changelog #387

DNin01 opened this issue Sep 30, 2023 · 5 comments
Assignees
Labels
scope: content Related to the contents of the website, excluding blog and docs type: enhancement New feature or request

Comments

@DNin01
Copy link
Member

DNin01 commented Sep 30, 2023

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?

@DNin01 DNin01 added type: enhancement New feature or request scope: content Related to the contents of the website, excluding blog and docs labels Sep 30, 2023
@Hans5958
Copy link
Member

Hans5958 commented Oct 1, 2023

cc @WorldLanguages (or whoever manages the release notes)

@WorldLanguages
Copy link
Member

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
Copy link
Member

Hans5958 commented Nov 3, 2023

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

@WorldLanguages
Copy link
Member

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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: content Related to the contents of the website, excluding blog and docs type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants