Skip to content

Commit 2aa4e89

Browse files
authored
docs: Rework the Configuring Squash Merging section of the README.md (#39)
1 parent 8267db1 commit 2aa4e89

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,18 +47,20 @@ Example
4747

4848
### Configuring Squash Merging
4949

50-
When merging pull requests, you can configure the merge behavior, including the option for squashing. Please follow these steps:
50+
When merging pull requests, you can configure the merge behavior, including the option for squashing. Follow these steps (or [Github's guide](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/configuring-commit-squashing-for-pull-requests)):
5151

52-
Go to your repository's Settings tab.
53-
Select the Options menu on the left sidebar.
54-
Under the Merge button section, you will find the merge options.
55-
To enable squash merging, select the checkbox for Allow squash merging.
56-
Select PR title as a default message for squashed commit.
57-
Make sure that at least one merge option is enabled (merge commits, squashing, or rebasing).
52+
1. Go to your repository's `Settings` tab.
53+
2. Select the `General` menu on the left sidebar.
54+
3. Under `Pull Requests`, select `Allow squash merging`. This allows contributors to merge a pull request by squashing all commits into a single commit.
55+
4. Select PR title as a default message for squashed commit.
5856

59-
When using the squash merge option, all commits from the head branch will be combined into a single commit in the base branch. The default commit message presented when merging a pull request with squash will be the PR title.
6057

6158
![squash_config.png](squash_config.png)
59+
60+
When using the squash merge option, all commits from the head branch will be combined into a single commit in the base branch. The default commit message presented when merging a pull request with squash will be the PR title.
61+
62+
Note: Make sure that at least one merge option is enabled (merge commits, squashing, or rebasing).
63+
6264
## Examples
6365

6466
### Basic Usage, no label, no ticket numbers validation

0 commit comments

Comments
 (0)