-
Notifications
You must be signed in to change notification settings - Fork 3k
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
Update documentation that news entries cannot be empty files #9657
Comments
I'd actually say that the correct fix is to allow empty |
Well, this is a good stopgap solution until we fix the issue on the bot. 🤷🏻♂️ |
I'm fine with that. I just wasn't sure if it was a temporary thing. |
I'm definitely viewing this as temporary, but it also won't hurt to just have people follow this long term. :) |
So we should change the documentation that contributors should add a news entry at |
Let's be explicit here, and just say that a |
ref: pypa/browntruck#24 |
This issue seems like a good first issue for beginning contributers. I would like to work on this issue. |
It appears that the new changelog GitHub App check handles empty files just fine: https://github.com/pypa/pip/pull/12534/files#diff-8a3182a318bebebaebb86d2efe42c6594eb98182b87d1a99e66a34b61705ed33. |
Yes, this has been fixed a while ago. Thanks for finding this! |
Currently, the documentation regarding news entries for trivial PRs mentions that contributors can create an empty news entry using for example the following command on Linux
touch news/$(uuidgen).trivial.rst
.The check for a news entry in PRs however does not longer allow empty
.trivial
files.https://github.com/pypa/pip/blob/master/docs/html/development/contributing.rst needs to be updated according to this.
The text was updated successfully, but these errors were encountered: