mirror of
https://gitflic.ru/project/openide/openide.git
synced 2026-09-27 10:03:11 +07:00
IJI-3089 Move commit message format info to internal documentation. Leave only minimal info in publicly available CONTRIBUTING.md
GitOrigin-RevId: 833d15c61cf9ba853012ef39cb08d99df2218500
This commit is contained in:
committed by
intellij-monorepo-bot
parent
65a97af615
commit
67f127cf73
@@ -39,31 +39,6 @@ E.g.:
|
||||
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 ticket and summarize it there.
|
||||
|
||||
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
|
||||
affect public API signatures)
|
||||
- `docs`, `doc`
|
||||
- `format`, `style`
|
||||
|
||||
E.g.:
|
||||
|
||||
```
|
||||
typo: “accross” → “across”
|
||||
```
|
||||
|
||||
## Building the IDE
|
||||
|
||||
Please read the [README.md](README.md) in order to understand how to build or
|
||||
|
||||
Reference in New Issue
Block a user