Skip to content

Update configuring-commit-squashing-for-pull-requests.md #27909

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.

Sign up for GitHub

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

Merged
am-stead merged 3 commits into from
Sep 7, 2023
Merged

Update configuring-commit-squashing-for-pull-requests.md #27909

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0da7d08
Update configuring-commit-squashing-for-pull-requests.md
jasonfb Aug 31, 2023
f9ba544
Apply suggestions from code review
am-stead Sep 7, 2023
f70728f
Merge branch 'main' into patch-3
am-stead Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ...nfiguring-pull-request-merges/configuring-commit-squashing-for-pull-requests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ shortTitle: Configure commit squashing

{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. On the "General" settings page (which is selected by default), scroll down to the section marked "Pull Requests".
1. Under "Pull Requests", select **Allow squash merging**. This allows contributors to merge a pull request by squashing all commits into a single commit. The default commit message presented to contributors when merging is the commit title and message if the pull request contains only 1 commit, or the pull request title and list of commits if the pull request contains 2 or more commits. {% ifversion ghes = 3.6 %} To always use the title of the pull request regardless of the number of commits in the pull request select **Default to PR title for squash merge commits**.{% endif %}
{% ifversion default-merge-squash-commit-message %}
1. Optionally, under **Allow squash merging**, select the dropdown menu, then click the format of the default squash commit message presented to contributors when merging.
Expand Down