Skip to content
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

Jump to bottom

Dev tools guide updates #17122

Merged
merged 3 commits into from
Sep 19, 2024
Merged

Dev tools guide updates #17122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e1eed3f
Git commit message convention: added a section about squash commits.
pomek Sep 19, 2024
7d21f45
Testing environment: removed the --debug option as it is not supporte…
pomek Sep 19, 2024
3fdaccc
Update docs/framework/contributing/git-commit-message-convention.md
pomek Sep 19, 2024
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
6 changes: 6 additions & 0 deletions docs/framework/contributing/git-commit-message-convention.md
View file
Open in desktop
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
View file
Open in desktop
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