Skip to content

docs: Rework the Configuring Squash Merging section of the README.md #39

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
merged 1 commit into from
Mar 5, 2025
Merged

docs: Rework the Configuring Squash Merging section of the README.md #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,18 +47,20 @@ Example

### Configuring Squash Merging

When merging pull requests, you can configure the merge behavior, including the option for squashing. Please follow these steps:
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)):

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

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.

![squash_config.png](squash_config.png)

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.

Note: Make sure that at least one merge option is enabled (merge commits, squashing, or rebasing).

## Examples

### Basic Usage, no label, no ticket numbers validation
Expand Down
Loading