|
| 1 | +# CLAUDE.md |
| 2 | + |
| 3 | +Цей файл містить правила для Claude Code при роботі в цьому репозиторії. |
| 4 | + |
| 5 | +## Про проект |
| 6 | + |
| 7 | +VS Code розширення **Claude Git Commit** — генерує повідомлення комітів через Claude AI (CLI або API). Публікується в VS Code Marketplace під publisher `ZakhariiMelnyk`. |
| 8 | + |
| 9 | +- Точка входу: [src/extension.ts](src/extension.ts) |
| 10 | +- Білд: webpack → [dist/extension.js](dist/extension.js) |
| 11 | +- Пакування: `vsce` → `.vsix` |
| 12 | + |
| 13 | +## Коміти — Conventional Commits (обов'язко��о) |
| 14 | + |
| 15 | +Release workflow парсить коміти й групує release notes **за префіксом**. Будь-який коміт без правильного префіксу потрапить у "📦 Other" або буде проігнорований. |
| 16 | + |
| 17 | +**Дозволені префікси** (розпізнає [.github/workflows/release.yml](.github/workflows/release.yml)): |
| 18 | + |
| 19 | +| Префікс | Секція в release notes | |
| 20 | +|---|---| |
| 21 | +| `feat:` / `feature:` | ✨ Features | |
| 22 | +| `fix:` | 🐛 Bug Fixes | |
| 23 | +| `perf:` | ⚡ Performance | |
| 24 | +| `refactor:` | ♻️ Refactoring | |
| 25 | +| `docs:` | 📝 Documentation | |
| 26 | +| `chore:` / `build:` / `ci:` | 🔧 Chores | |
| 27 | + |
| 28 | +**Правила:** |
| 29 | +- Scope в дужках заохочується: `fix(cli): ...`, `feat(prompts): ...` |
| 30 | +- Мова повідомлення — українська (див. попередні коміти), але префікс англійською |
| 31 | +- **НЕ** створювати коміти виду `1.0.17` вручну — це робить release workflow. Коміти, що починаються з цифри, ігноруються парсером нотаток |
| 32 | +- Merge-коміти виключені з нотаток (`--no-merges`) |
| 33 | +- Ніколи не використовувати `--no-verify`, `--amend` на запушених комітах, `git push --force` без явної вказівк�� користувача |
| 34 | + |
| 35 | +## Випуск нової версії |
| 36 | + |
| 37 | +**НЕ робити вручну** крім випадків, коли користувач прямо просить. Стандартний флоу: |
| 38 | + |
| 39 | +1. Переконатися що `main` чистий і CI зелений |
| 40 | +2. Підняти версію: `npm version patch|minor|major --no-git-tag-version` |
| 41 | +3. Зробити коміт версії (виняток із правила conventional commits — формат `X.Y.Z`, як у попередніх релізах) |
| 42 | +4. Створити тег: `git tag vX.Y.Z` |
| 43 | +5. Запушити: `git push && git push origin vX.Y.Z` |
| 44 | +6. GitHub Actions [release.yml](.github/workflows/release.yml) автоматично: |
| 45 | + - Збере `.vsix` |
| 46 | + - Згенерує release notes з комітів від попереднього тегу |
| 47 | + - Створить GitHub Release з прикріпленим `.vsix` |
| 48 | + - Опублікує в Marketplace (якщо секрет `VSCE_PAT` налаштований) |
| 49 | + |
| 50 | +**Альтернатива:** ручний запуск через `workflow_dispatch` в GitHub UI з полем `version`. |
| 51 | + |
| 52 | +**Semver:** |
| 53 | +- `patch` — баг-фікси, зміни без впливу на API/поведінку |
| 54 | +- `minor` — нові фічі, зворотньо сумісні |
| 55 | +- `major` — breaking changes (змінені команди, налаштування, поведінка за замовчуванням) |
| 56 | + |
| 57 | +## GitHub Actions |
| 58 | + |
| 59 | +Два workflow: |
| 60 | + |
| 61 | +### [.github/workflows/ci.yml](.github/workflows/ci.yml) |
| 62 | +Запускається на PR та пуш в `main`. Робить: `npm ci` → lint → `npm run package` → dry-run `vsce package`. Артефакт `.vsix` зберігається 7 днів. **Не ламати цей пайплайн** — якщо lint/build падає, виправляти, а не обходити. |
| 63 | + |
| 64 | +### [.github/workflows/release.yml](.github/workflows/release.yml) |
| 65 | +Тригери: |
| 66 | +- Пуш тегу `v*.*.*` |
| 67 | +- Ручний запуск (`workflow_dispatch`) з параметрами `version` і `publish` |
| 68 | + |
| 69 | +Workflow сам синхронізує `package.json` з версією тегу через `npm version --no-git-tag-version`, якщо вони розходяться. Це означає: **якщо ти підняв версію вручну перед тегом — це ок, якщо ні — workflow підтягне сам**. |
| 70 | + |
| 71 | +**Секрети:** |
| 72 | +- `VSCE_PAT` — токен для публікації в Marketplace. Якщо не встановлений, workflow лише створить GitHub Release з warning'ом, не впаде. |
| 73 | +- `GITHUB_TOKEN` — вбудований, використовується `softprops/action-gh-release` для створення релізу. |
| 74 | + |
| 75 | +### Правила модифікації workflow |
| 76 | +- Будь-які зміни в `.github/workflows/**` комітити з префіксом `ci:` |
| 77 | +- Не додавати кроки, які роблять `git push` назад у репо без явної потреби (створює ризик інфінітних циклів) |
| 78 | +- Якщо змінюєш логіку генерації release notes — переконайся, що парсер коректно обробляє всі 6 типів conventional commits і не ламається на порожньому range (перший реліз) |
| 79 | +- Тестувати workflow можна через `workflow_dispatch` перед тим як виливати через тег |
| 80 | + |
| 81 | +## Білд і пакування вручну |
| 82 | + |
| 83 | +```bash |
| 84 | +npm run package # webpack production build |
| 85 | +npx vsce package # створити .vsix |
| 86 | +``` |
| 87 | + |
| 88 | +Результат — `claude-git-commit-X.Y.Z.vsix` в корені. `.vsix` файли **закомічені в репозиторій** (історичні релізи) — нові додавати тільки якщо випускаєш вручну без CI. |
| 89 | + |
| 90 | +## Файли, яких НЕ чіпати без потреби |
| 91 | +- `package.json` поле `version` — керується релізним процесом |
| 92 | +- `.vscodeignore` — впливає на розмір пакета, перевіряти тест-пакуванням після змін |
| 93 | +- Історичні `.vsix` в корені — не видаляти без прохання користувача |
| 94 | + |
| 95 | +## Мова |
| 96 | +Відповіді користувачу — українською. Префікси комітів, назви змінних, код — англійською. |
0 commit comments