Skip to content

Commit

Permalink
Update docs/framework/contributing/git-commit-message-convention.md
Browse files Browse the repository at this point in the history
Co-authored-by: Bartek Biedrzycki <[email protected]>
  • Loading branch information
pomek and godai78 authored Sep 19, 2024
1 parent 7d21f45 commit 3fdaccc
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ All entries must be separated with a blank line, otherwise the lines will not be

The changelog generator understands squash commits created by GitHub when merging a pull request.

When using the _"Squash and merge"_ option, ensure the default commit title is not modified. It should contain the pull request title and its number, e.g., `Example pull request (#000)`. The changelog entries should be added as a commit description. They must follow the same rules as merge commits.
When using the _"Squash and merge"_ option, ensure the default commit title is not modified. It should contain the pull request title and its number, for example: `Sample pull request (#000)`. The changelog entries should be added as a commit description. They must follow the same rules as merge commits.

### Examples of correct and incorrect message formatting

Expand Down

0 comments on commit 3fdaccc

Please sign in to comment.