search

typeddjango / django-stubs

PEP-484 stubs for Django
MIT License
1.52k stars 425 forks source link

Please, don't tag all contributors in release notes #2220

Closed sobolevn closed 4 weeks ago

sobolevn commented 1 month ago

Our current release notes tag all contributors on GitHub: https://github.com/typeddjango/django-stubs/releases/tag/5.0.2

I've recieved several complaints about that. I think that we should not do that. Let's respect people's notification space :)

I propose to change it to:

- [by some-person](link-to-github-profile) in #gh-pr-number

if this is possible. If not, we can just drop the name part, only keeping the PR number. It will show the author.

intgr commented 1 month ago

I thought release notes @tags don't create a notification. Or is it because I'm subscribed to releases anyway?

I thought the only reason for pings was when I checked the box to also create a discussion for the release. https://github.com/typeddjango/django-stubs/discussions/2096

sobolevn commented 1 month ago

Can you please try to create a release (maybe on some test project) and ping me in the description there? I will show what will happen :)

intgr commented 1 month ago

Sure, will try when I'm back behind a computer

intgr commented 4 weeks ago

I did it yesteday, did you receive a notification? https://github.com/intgr/test-idea-plugin/releases/tag/test-release

sobolevn commented 4 weeks ago

Nope 🎉

intgr commented 4 weeks ago

Our release process is undocumented and not totally straightforward.

I think the "final" solution to this is to create a step-by-step list of instructions about what to do for each release. I already alluded to that in https://github.com/typeddjango/django-stubs/pull/2183#issuecomment-2133319819 too.

There we can document to keep unchecked "Create a discussion for this release" when making a release.

What do you think?

sobolevn commented 4 weeks ago

Yes, sounds good to me. https://github.com/typeddjango/django-stubs/blob/master/CONTRIBUTING.md can store this info.