From 65a97af615d4750c5bd504a9b6276fe9e4729bfb Mon Sep 17 00:00:00 2001 From: Piotr Tomiak Date: Wed, 29 Oct 2025 14:35:59 +0100 Subject: [PATCH] IJI-3089 Monorepo DevKit: update rules on commit message format wording. GitOrigin-RevId: 689ae25fd36b2f6d65c33059c98e807a8c971a5a --- CONTRIBUTING.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6f9dca439ef..e12f22499cd7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,27 +23,34 @@ Before you start, make sure you: We strongly recommend following this commit message format: ``` - [] short description - - 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: + ``` + : + + + ``` + + 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