Дякуємо за ваш інтерес до участі в цьому проєкті! Цей довідник допоможе вам зрозуміти, як ефективно зробити внесок.

Про цей проєкт

Claude How To — це візуальний, заснований на прикладах довідник з Claude Code. Ми надаємо:

Типи внесків

1. Нові приклади або шаблони

Додавайте приклади для існуючих функцій (слеш-команди, навички, хуки тощо):

2. Покращення документації

3. Гайди з функцій

Створюйте гайди для нових функцій Claude Code:

4. Звіти про помилки

Повідомляйте про проблеми:

5. Відгуки та пропозиції

Допоможіть покращити довідник:

Початок роботи

1. Форк та клонування

git clone YOUR_REPO
cd claude-howto

2. Створення гілки

Використовуйте описову назву гілки:

git checkout -b add/feature-name
git checkout -b fix/issue-description
git checkout -b docs/improvement-area

3. Налаштування середовища

Pre-commit хуки запускають ті ж перевірки, що й CI, локально перед кожним комітом. Усі чотири перевірки повинні пройти перед прийняттям PR.

Необхідні залежності:

# Python tooling (uv is the package manager for this project)
pip install uv
uv venv
source .venv/bin/activate
uv pip install -r scripts/requirements-dev.txt

# Markdown linter (Node.js)
npm install -g markdownlint-cli

# Mermaid diagram validator (Node.js)
npm install -g @mermaid-js/mermaid-cli

# Install pre-commit and activate hooks
uv pip install pre-commit
pre-commit install

Перевірка налаштування:

pre-commit run --all-files

Хуки, що запускаються при кожному коміті:

Хук Що перевіряє
markdown-lint Форматування та структуру Markdown
cross-references Відносні посилання, якорі, блоки коду
mermaid-syntax Усі блоки ```mermaid коректно парсяться
link-check Зовнішні URL-адреси доступні
build-epub EPUB генерується без помилок (при змінах .md)

Структура каталогів

├── 01-slash-commands/      # Ярлики, ініційовані користувачем
├── 02-memory/              # Приклади постійного контексту
├── 03-skills/              # Повторно використовувані можливості
├── 04-subagents/           # Спеціалізовані AI-асистенти
├── 05-mcp/                 # Приклади Model Context Protocol
├── 06-hooks/               # Автоматизація на основі подій
├── 07-plugins/             # Пакетні функції
├── 08-checkpoints/         # Знімки сесій
├── 09-advanced-features/   # Планування, мислення, фони
├── 10-cli/                 # Довідник CLI
├── scripts/                # Скрипти збірки та утиліт
└── README.md               # Основний довідник

Як зробити внесок прикладів

Додавання слеш-команди

  1. Створіть файл .md в 01-slash-commands/
  2. Включіть:
    • Чіткий опис що вона робить
    • Сценарії використання
    • Інструкції з встановлення
    • Приклади використання
    • Поради з налаштування
  3. Оновіть 01-slash-commands/README.md

Додавання навички

  1. Створіть каталог в 03-skills/
  2. Включіть:
    • SKILL.md — основна документація
    • scripts/ — допоміжні скрипти за потреби
    • templates/ — шаблони промптів
    • Приклади використання в README
  3. Оновіть 03-skills/README.md

Додавання субагента

  1. Створіть файл .md в 04-subagents/
  2. Включіть:
    • Призначення та можливості агента
    • Структуру системного промпту
    • Приклади використання
    • Приклади інтеграції
  3. Оновіть 04-subagents/README.md

Додавання конфігурації MCP

  1. Створіть файл .json в 05-mcp/
  2. Включіть:
    • Пояснення конфігурації
    • Необхідні змінні оточення
    • Інструкції з налаштування
    • Приклади використання
  3. Оновіть 05-mcp/README.md

Додавання хука

  1. Створіть файл .sh в 06-hooks/
  2. Включіть:
    • Shebang та опис
    • Чіткі коментарі, що пояснюють логіку
    • Обробку помилок
    • Міркування безпеки
  3. Оновіть 06-hooks/README.md

Настанови з написання

Стиль Markdown

Приклади коду

Документація

JSON/YAML

Діаграми

Настанови для комітів

Дотримуйтесь формату conventional commits:

type(scope): description

[optional body]

Типи:

Приклади:

feat(slash-commands): Add API documentation generator
docs(memory): Improve personal preferences example
fix(README): Correct table of contents link
docs(skills): Add comprehensive code review skill

Перед відправкою

Чеклист

Локальне тестування

# Run all pre-commit checks (same checks as CI)
pre-commit run --all-files

# Review your changes
git diff

Процес Pull Request

  1. Створіть PR з чітким описом:

    • Що додає/виправляє?
    • Чому це потрібно?
    • Пов'язані issues (якщо є)

  2. Включіть відповідні деталі:

    • Нова функція? Включіть сценарії використання
    • Документація? Поясніть покращення
    • Приклади? Покажіть до/після

  3. Посилайтесь на issues:

    • Використовуйте Closes #123 для автоматичного закриття пов'язаних issues

  4. Будьте терплячими з рев'ю:

    • Мейнтейнери можуть запропонувати покращення
    • Ітеруйте на основі зворотного зв'язку
    • Остаточне рішення за мейнтейнерами

Процес код-рев'ю

Рецензенти перевірять:

Повідомлення про проблеми

Звіти про помилки

Включіть:

Запити на функції

Включіть:

Проблеми з документацією

Включіть:

Політики проєкту

Чутлива інформація

Якість коду

Інтелектуальна власність

Отримання допомоги

Визнання

Контриб'юторів відзначають у:

Безпека

При внесенні прикладів та документації, будь ласка, дотримуйтесь безпечних практик кодування:

Щодо проблем безпеки, див. SECURITY.md для нашого процесу повідомлення про вразливості.

Кодекс поведінки

Ми зобов'язуємося забезпечити привітну та інклюзивну спільноту. Будь ласка, прочитайте CODE_OF_CONDUCT.md для повних стандартів спільноти.

Коротко:

Усі контриб'ютори повинні дотримуватися цього кодексу та ставитися одне до одного з добротою та повагою.

Ліцензія

Роблячи внесок у цей проєкт, ви погоджуєтесь, що ваші внески будуть ліцензовані за ліцензією MIT. Деталі див. у файлі LICENSE.

Запитання?

Дякуємо за ваш внесок! 🙏

Останнє оновлення: Квітень 2026