95 lines
8.8 KiB
Markdown
95 lines
8.8 KiB
Markdown
# 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`.
|
|
Keep it a concise summary. The scope is optional and names an instrument or
|
|
section, e.g. `[mix:vox]`, `[track:gtr]`.
|
|
|
|
### Prefixes
|
|
|
|
| Prefix | When to use | Example |
|
|
| -------- | ------------------------------------------------------------------- | ------------------------------------------------ |
|
|
| `sketch` | Early phase: composition, arrangement and mix are still intertwined | `[sketch] Rough verse and chorus, draft balance` |
|
|
| `comp` | Material: melody, harmony, structure | `[comp] Rewrite the bridge, drop the pre-chorus` |
|
|
| `arr` | Arrangement, instrumentation | `[arr] Add string pad to the chorus` |
|
|
| `track` | Recording live audio | `[track:gtr] Solo guitar (Artem), 3 takes` |
|
|
| `midi` | MIDI and virtual instruments | `[midi] Verse drums, fix the groove` |
|
|
| `edit` | Processing recordings: comping, timing, tuning, cleanup | `[edit:vox] Comp the lead, clean up breaths` |
|
|
| `mix` | Mixing | `[mix:vox] De-esser on lead, +1.5 dB in chorus` |
|
|
| `master` | Mastering (the process) | `[master] Limiter, target -9 LUFS` |
|
|
| `export` | Emitting files into Out/ (audio, PDF) | `[export] Master v1, instrumental, stems` |
|
|
| `score` | Notation source (.mscz) | `[score] Solo guitar part, clean copy` |
|
|
| `asset` | Non-audio resources: presets, FX chains, cover art | `[asset] Cover v2, master-bus preset` |
|
|
| `docs` | Documentation, README | `[docs] Update the description` |
|
|
| `chore` | Repo plumbing: structure, gitignore/gitattributes, LFS | `[chore] Track .mscz with LFS` |
|
|
| `fix` | Fixes: bad take, clipping, wrong file, revert | `[fix] Remove clipping at 2:13, re-export stem` |
|
|
|
|
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`。
|