Skip to content

Commit

Permalink
Merge pull request #17122 from ckeditor/tools-docs-update
Browse files Browse the repository at this point in the history
Internal: Added a "Squash commits" section to the "Git commit message convention" guide.

Internal: Removed the `--debug` modifier from the "Running automated tests" section in the "Testing environment" guide as it is not supported after switching sources to TypeScript.
  • Loading branch information
pomek authored Sep 19, 2024
2 parents fe384e0 + 3fdaccc commit 9efff53
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/framework/contributing/git-commit-message-convention.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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

An example of a proper commit message:
Expand Down
1 change: 0 additions & 1 deletion docs/framework/contributing/testing-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 9efff53

Please sign in to comment.