Remove the GitHub pull request template #16415
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Pull request descriptions are always important. In the case of this repository, they are doubly important since we use a merge queue configured to squash commits and use pull request descriptions as squashed commit messages. This means that the most beautiful commit messages in the world mean nothing if they don't make it uncontaminated into a pull request description. Unfortunately, contamination is the name of the game with our current pull request template. While designed with good intentions -- helping contributors ensure that they have formatted, linted, tested, and described their code in a changelog entry, it comes with a serious downside. Its HTML comments and checklist entries make it into our Git commit history unless meticulously cleaned out by every contributor, making for an ugly commit log full of noise and bloat. Given that we now have tooled workflows to address these risks*, it's time to remove it and save our commit log from future corruption. *The exception is the Pulumi Cloud API notice, but this commit argues that this checklist item is both uncommon and has been ineffective in helping address this risk.
Changelog[uncommitted] (2024-06-18) |
lunaris
added
the
impact/no-changelog-required
tgummerer
approved these changes
Jun 18, 2024
|
I am also in favor of this. Maybe we can have a bot post a message about PR guidelines. Or we could strip down the PR template to point to a section in contributing.md. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull request descriptions are always important. In the case of this repository, they are doubly important since we use a merge queue configured to squash commits and use pull request descriptions as squashed commit messages. This means that the most beautiful commit messages in the world mean nothing if they don't make it uncontaminated into a pull request description.
Unfortunately, contamination is the name of the game with our current pull request template. While designed with good intentions -- helping contributors ensure that they have formatted, linted, tested, and described their code in a changelog entry, it comes with a serious downside. Its HTML comments and checklist entries make it into our Git commit history unless meticulously cleaned out by every contributor, making for an ugly commit log full of noise and bloat. Given that we now have tooled workflows to address these risks*, it's time to remove it and save our commit log from future corruption.
*The exception is the Pulumi Cloud API notice, but this commit argues that this checklist item is both uncommon and has been ineffective in helping address this risk.