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

Making news entries optional for documentation-only changes #363

Closed
isidentical opened this issue Nov 15, 2019 · 4 comments · Fixed by python/bedevere#485
Closed

Making news entries optional for documentation-only changes #363

isidentical opened this issue Nov 15, 2019 · 4 comments · Fixed by python/bedevere#485

Comments

@isidentical
Copy link
Member

The short story

It would be nice if news entries can be optional by default in documentation-only changes.

Long version

Most of the documentation change cases, news entries aren't important. It would be nice to automatically skip news entry check on [type-documentation] labeled PRs.

@brettcannon
Copy link
Member

"Most of the documentation change cases, news entries aren't important", but as you admit that isn't always the case. The point of having a label to opt out is to make sure it is an explicit opt-out of a news entry so people don't forget. If we made this change there would be an increase in instances where people forgot the news entry when it was appropriate.

@isidentical
Copy link
Member Author

Thanks for your response. That is a valid point. I have another idea but i don't think that is suitable for this workflow (you can close the issue if you agree with me): using a bot command to label our own PRs without triage permission. Like '@botsname label skip-news, @botsname skip-issue

@terryjreedy
Copy link
Member

terryjreedy commented Nov 15, 2019

I agree with Brett. Our general rule is that if something is important enough to merit an issue, it should get a news entry. There are a few exceptions, mostly for doc issues. But these are fewer since we moved to github. Trivial doc changes are now often reported with a no-issue PR instead of a bpo issue.

@brettcannon
Copy link
Member

@isidentical giving PR authors abilities to specify labels on their own is a separate issue (there may already be one open?). There's also the question as to whether people will use the labels appropriately (e.g. saying to skip news when in fact it shouldn't). But anyway, separate discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

3 participants