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

Change Request: switch to PR title for default commit message #17555

Closed
1 task done
mdjermanovic opened this issue Sep 11, 2023 · 4 comments
Closed
1 task done

Change Request: switch to PR title for default commit message #17555

mdjermanovic opened this issue Sep 11, 2023 · 4 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion infrastructure Relates to the tools used in the ESLint development process

Comments

@mdjermanovic
Copy link
Member

ESLint version

main

What problem do you want to solve?

Currently, when there's only one commit on the PR, default commit message presented when merging a pull request with squash is the message of that commit.

Therefore, in such cases (when there's only one commit), if the format of the message is incorrect, we ask the contributor to update the commit message. Sometimes we fix the message manually while merging, which is error-prone because there's no validation at that point. Sometimes we update a technically valid message to better describe the change, which is again error-prone because there's no validation.

What do you think is the correct solution?

GitHub now provides options to always default to the PR title:

image

The proposal is to switch to "Default to pull request title and commit details".

That would simplify the process for everyone - whenever we need to change the message, we just update the PR title and let the bot validate it.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

Tasks would be to update the bot to always check the PR title, and then update settings in all repositories.

@mdjermanovic mdjermanovic added the infrastructure Relates to the tools used in the ESLint development process label Sep 11, 2023
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Sep 11, 2023
@mdjermanovic mdjermanovic moved this from Needs Triage to Feedback Needed in Triage Sep 11, 2023
@nzakas nzakas moved this from Feedback Needed to Ready to Implement in Triage Sep 11, 2023
@nzakas nzakas added the accepted There is consensus among the team that this change meets the criteria for inclusion label Sep 11, 2023
@nzakas
Copy link
Member

nzakas commented Sep 11, 2023

Agreed, let's do it.

@snitin315
Copy link
Contributor

Yes, let's do it in all repos.

@mdjermanovic
Copy link
Member Author

I'm working on the bot update.

@mdjermanovic
Copy link
Member Author

The bot update has been merged and I've just updated the settings in all repositories, so I think we can close this now.

@github-project-automation github-project-automation bot moved this from Implementing to Complete in Triage Sep 13, 2023
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Mar 12, 2024
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Mar 12, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion infrastructure Relates to the tools used in the ESLint development process
Projects
Archived in project
Development

No branches or pull requests

3 participants