From e1eed3f643278b07813ce1406651131b48b6dd97 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 19 Sep 2024 08:36:14 +0200 Subject: [PATCH 1/3] Git commit message convention: added a section about squash commits. --- .../framework/contributing/git-commit-message-convention.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/framework/contributing/git-commit-message-convention.md b/docs/framework/contributing/git-commit-message-convention.md index 1eb919a637b..d6f7877989f 100644 --- a/docs/framework/contributing/git-commit-message-convention.md +++ b/docs/framework/contributing/git-commit-message-convention.md @@ -97,6 +97,12 @@ The proper order of sections for a commit message is as follows: All entries must be separated with a blank line, otherwise the lines will not be treated as separate entries. +### Squash commits + +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. + ### Examples of correct and incorrect message formatting An example of a proper commit message: From 7d21f456764910126f4bd57900c19690235460c3 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 19 Sep 2024 08:37:17 +0200 Subject: [PATCH 2/3] Testing environment: removed the --debug option as it is not supported in automated tests. --- docs/framework/contributing/testing-environment.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/framework/contributing/testing-environment.md b/docs/framework/contributing/testing-environment.md index ff41807540e..10650ced42e 100644 --- a/docs/framework/contributing/testing-environment.md +++ b/docs/framework/contributing/testing-environment.md @@ -31,7 +31,6 @@ It accepts the following arguments that must be passed after the `--` option: * `--verbose` (alias `-v`) – Allows switching on webpack logs. * `--files` – Specifies test files to run. See the [Rules for using the `--files` option](#rules-for-using-the-files-option) section. * `--browsers` – Browsers that will be used to run the tests. Defaults to `Chrome`. -* `--debug` (alias `-d`) – Allows specifying custom debug flags. For example, the `--debug engine` option uncomments the `// @if CK_DEBUG_ENGINE //` lines in the code. By default `--debug` is set to `true` even if you did not specify it. This enables the base set of debug logs (`// @if CK_DEBUG //`) which should always be enabled in the testing environment. You can completely turn off the debug mode by setting the `--debug false` option. * `--port` – Specifies the port for the server to use. Defaults to `9876`. * `--identity-file="/path/to/file.js"` (alias `-i`) – Path to the file containing the license key(s) for closed–source features. From 3fdacccd739a22390d2bfd8024bd008ac7886310 Mon Sep 17 00:00:00 2001 From: Kamil Piechaczek Date: Thu, 19 Sep 2024 08:56:07 +0200 Subject: [PATCH 3/3] Update docs/framework/contributing/git-commit-message-convention.md Co-authored-by: Bartek Biedrzycki <68123541+godai78@users.noreply.github.com> --- docs/framework/contributing/git-commit-message-convention.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/framework/contributing/git-commit-message-convention.md b/docs/framework/contributing/git-commit-message-convention.md index d6f7877989f..22654e405ec 100644 --- a/docs/framework/contributing/git-commit-message-convention.md +++ b/docs/framework/contributing/git-commit-message-convention.md @@ -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