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

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

Closed
sobolevn opened this issue Jun 14, 2024 · 7 comments
Closed

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

sobolevn opened this issue Jun 14, 2024 · 7 comments
Labels
meta Meta-issues and discussion

Comments

@sobolevn
Copy link
Member

sobolevn commented Jun 14, 2024

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.

@sobolevn sobolevn added the meta Meta-issues and discussion label Jun 14, 2024
@intgr
Copy link
Collaborator

intgr commented Jun 15, 2024

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. #2096

@sobolevn
Copy link
Member Author

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

intgr commented Jun 15, 2024

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

@intgr
Copy link
Collaborator

intgr commented Jun 16, 2024

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

@sobolevn
Copy link
Member Author

Nope 🎉

@intgr
Copy link
Collaborator

intgr commented Jun 17, 2024

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 #2183 (comment) too.

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

What do you think?

@sobolevn
Copy link
Member Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta Meta-issues and discussion
Development

No branches or pull requests

2 participants