From 68e82a510a316338f7f488e7cf56070f3f36ba2d Mon Sep 17 00:00:00 2001 From: Masahiko AMANO Date: Tue, 30 Jun 2026 19:14:18 +0300 Subject: [PATCH] [docs] Add Russian and Japanese sections to COMMITS.md --- COMMITS.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 69 insertions(+), 2 deletions(-) diff --git a/COMMITS.md b/COMMITS.md index 049802c..c0e68eb 100644 --- a/COMMITS.md +++ b/COMMITS.md @@ -1,10 +1,17 @@ -# Commit conventions +# Commit conventions / Соглашения по коммитам / コミット規約 + +Sections below: [English](#english), [Русский](#русский), [日本語](#日本語). +Prefix tokens are always in English; only the descriptions are localized. + +--- + +## English Format: `[prefix] description` or `[prefix:scope] description`. Use the imperative mood. The scope is optional and names an instrument or section, e.g. `[mix:vox]`, `[track:gtr]`. -## Prefixes +### Prefixes | Prefix | When to use | Example | | -------- | ------------------------------------------------------------------- | ------------------------------------------------ | @@ -25,3 +32,63 @@ section, e.g. `[mix:vox]`, `[track:gtr]`. Core day-to-day flow: `sketch -> comp/arr -> track/midi/edit -> mix -> master -> export`. Rarely used: `fix`, `chore`, `asset`. + +--- + +## Русский + +Формат: `[префикс] описание` или `[префикс:scope] описание`. +Повелительное наклонение. Скоуп необязателен — это инструмент или секция, +например `[mix:vox]`, `[track:gtr]`. + +### Префиксы + +| Префикс | Когда применять | Пример | +| -------- | ------------------------------------------------------------ | ---------------------------------------------------- | +| `sketch` | Ранний этап: композиция, аранжировка и микс ещё нераздельны | `[sketch] Набросок куплета и припева, грубый баланс` | +| `comp` | Материал: мелодия, гармония, структура | `[comp] Переписал бридж, убрал предприпев` | +| `arr` | Аранжировка, инструментовка | `[arr] Подклад струнных в припев` | +| `track` | Запись живого аудио | `[track:gtr] Соло-гитара (Артём), 3 дубля` | +| `midi` | MIDI и виртуальные инструменты | `[midi] Барабаны куплета, поправил грув` | +| `edit` | Обработка записи: компинг, тайминг, тюнинг, чистка | `[edit:vox] Компинг лида, чистка дыханий` | +| `mix` | Сведение | `[mix:vox] Де-эссер на лиде, +1.5 dB в припеве` | +| `master` | Мастеринг (процесс) | `[master] Лимитер, целевой -9 LUFS` | +| `export` | Выпуск файлов в Out/ (аудио, PDF) | `[export] Мастер v1, инструментал, стемы` | +| `score` | Ноты (исходник .mscz) | `[score] Партия соло-гитары набело` | +| `asset` | Не-аудио: пресеты, FX-цепи, обложка | `[asset] Обложка v2, пресет мастер-шины` | +| `docs` | Документация, README | `[docs] Обновил описание` | +| `chore` | Обвязка репозитория: структура, gitignore/gitattributes, LFS | `[chore] .mscz в LFS` | +| `fix` | Исправления: плохой дубль, клиппинг, не тот файл, откат | `[fix] Убрал клиппинг в 2:13, перезалил стем` | + +Ядро повседневного потока: `sketch -> comp/arr -> track/midi/edit -> mix -> master -> export`. +Редко: `fix`, `chore`, `asset`. + +--- + +## 日本語 + +形式：`[プレフィックス] 説明` または `[プレフィックス:scope] 説明`。 +説明は簡潔に要点をまとめる。スコープは任意で、楽器またはセクションを指す +（例：`[mix:vox]`、`[track:gtr]`）。プレフィックスは常に英字。 + +### プレフィックス + +| プレフィックス | 用途 | 例 | +| -------------- | -------------------------------------------------------- | ----------------------------------------------------- | +| `sketch` | 初期段階：作曲・アレンジ・ミックスがまだ一体 | `[sketch] Aメロとサビのラフ、仮バランス` | +| `comp` | 素材：メロディ、ハーモニー、構成 | `[comp] ブリッジを書き直し、Bメロを削除` | +| `arr` | アレンジ、楽器編成 | `[arr] サビにストリングスパッドを追加` | +| `track` | 生音の録音 | `[track:gtr] ギターソロ（Artem）、3テイク` | +| `midi` | MIDI・ソフト音源 | `[midi] Aメロのドラム、グルーヴを修正` | +| `edit` | 録音の処理：コンピング、タイミング、ピッチ補正、整理 | `[edit:vox] リードのコンピング、ブレスを整理` | +| `mix` | ミックス | `[mix:vox] リードにディエッサー、サビで +1.5 dB` | +| `master` | マスタリング（作業） | `[master] リミッター、目標 -9 LUFS` | +| `export` | Out/ へのファイル書き出し（オーディオ、PDF） | `[export] マスター v1、インスト、ステム` | +| `score` | 楽譜のソース（.mscz） | `[score] ギターソロのパート譜を清書` | +| `asset` | 非オーディオ：プリセット、エフェクトチェイン、ジャケット | `[asset] ジャケット v2、マスターバスのプリセット` | +| `docs` | ドキュメント、README | `[docs] 説明を更新` | +| `chore` | リポジトリの整備：構成、gitignore/gitattributes、LFS | `[chore] .mscz を LFS で管理` | +| `fix` | 修正：不良テイク、クリッピング、ファイル違い、取り消し | `[fix] 2:13 のクリッピングを除去、ステムを再書き出し` | + +日常の基本フロー：`sketch -> comp/arr -> track/midi/edit -> mix -> master -> export`。 +まれに使用：`fix`、`chore`、`asset`。