IJI-3089 Monorepo DevKit: update rules on commit message format wording.

GitOrigin-RevId: 689ae25fd36b2f6d65c33059c98e807a8c971a5a
This commit is contained in:
Piotr Tomiak
2025-11-01 01:58:00 +00:00
committed by intellij-monorepo-bot
parent 0c5e3ef7b5
commit 65a97af615
+23 -12
View File
@@ -23,27 +23,34 @@ Before you start, make sure you:
We strongly recommend following this commit message format:
```
[<subsystem>] <YouTrack ticket ID/category keyword for non-production changes (see allowed list below)> short description
detailed description
<YouTrack ticket ID>( <YouTrack ticket ID>)* (<subsystem>: )? <subject>
<detailed description>?
```
E.g.:
```
[groovy] IDEA-125730 Declare explicit type
IDEA-125730 Groovy: declare explicit type
Broken template should revert all its changes and move the caret back to the original position
Broken template should revert all its changes and move the caret back to the original position
```
Avoid including links to any discussions in commit messages (Slack, https://platform.jetbrains.com/, etc.). Instead, summarize the
discussion right in the commit message,
or create a YouTrack issue and summarize it there.
discussion right in the commit message, or create a YouTrack ticket and summarize it there.
1. If the commit changes a product's distribution, always include a link to the corresponding YouTrack ticket.
2. If the commit does not change a product's distribution (e.g., tests, documentation, formatting, etc.), it should contain category keyword
instead of ticket id.
Possible keywords:
Avoid using previously encouraged subsystem prefix (e.g. `[groovy]`), because many projects do not have a subsystem. Instead, place
the subsystem name right after the issue id.
1. If the commit changes a product's distribution, the YouTrack ticket id is required to be present in the commit message.
2. If the commit does not change a product's distribution (e.g., tests, documentation, formatting, etc.), the message should be in the following format:
```
<non-production code change label>: <subject>
<detailed description>
```
Possible labels:
- `tests`, `test`
- `cleanup`, `typo`
- `refactor`, `refactoring` for small refactorings (e.g., renaming a local variable, extracting private method, changes which don't
@@ -51,7 +58,11 @@ or create a YouTrack issue and summarize it there.
- `docs`, `doc`
- `format`, `style`
Example: ```[ui] typo “accross” → “across”```
E.g.:
```
typo: “accross” → “across”
```
## Building the IDE