Formerly KrillinAI, VideoTranslation and Dubbing Tool for 120+ Languages. Open-source AI workspace for creators, powered by Codex. Video downloader, video translation, create videos, images, audios, and edits with Agents in one place. For your Social Media like YouTube, TikTok, Instagram, etc.
Руководство для контрибьюторов (Русский)
English | 简体中文 | 日本語 | 한국어 | Bahasa Indonesia | Español | Français | Deutsch | Português | Русский | العربية
Спасибо, что хотите внести вклад в OpenCreator. OpenCreator — это локальное рабочее пространство для авторов, построенное на агентном цикле Codex, и бо́льшая часть его ценности рождается из небольших сфокусированных дополнений: одна папка Skill, один шаблон создания, одно чётко ограниченное исправление. Это руководство объясняет, где должен находиться каждый тип вклада и каким требованиям должен соответствовать PR перед слиянием.
Карта вкладов
| Если вы хотите… | Вы фактически добавляете | Где это находится | Размер поставки |
|---|---|---|---|
| Исправить баг или улучшить рабочий процесс | код | apps/web/, apps/daemon/ |
один сфокусированный PR с тестами |
| Добавить переиспользуемый рабочий процесс агента | Skill | skills/<ваш-skill>/ |
одна папка с SKILL.md и необязательными references → руководство |
| Добавить переиспользуемый пресет изображения, видео или обложки | шаблон создания | template/<модуль>/<id>/<версия>/ |
одна папка с template.json и ресурсами → руководство |
| Внести иллюстрации, иконки или дизайн UI | дизайн-ресурсы | согласованное место для ресурсов | один PR с превью, исходниками и лицензией |
| Подключить ИИ- или медиасервис | сервисную интеграцию | соответствующий модуль Web или Daemon | один PR с обработкой ошибок, безопасностью учётных данных и тестами |
| Улучшить документацию или переводы | документы | README.md, docs/, docs/<locale>/README.md |
один PR |
Где задавать вопросы и кто проверяет
Откройте issue, чтобы обсудить идею или уточнить нужную область. Отправляя PR, упомяните участника команды, отвечающего за код и ошибки, шаблоны, дизайн и материалы или Skills и документацию. Команда помогает со стандартами, проверками и вопросами сообщества; слияние зависит от прав в репозитории и обязательных проверок.
Локальная установка
Полная установка описана в быстром старте README. Краткая версия для контрибьюторов:
git clone https://github.com/krillinai/OpenCreator.git
cd OpenCreator
corepack enable # выбирает закреплённый pnpm из packageManager
pnpm install
pnpm web:dev # web + локальный daemon по требованию
pnpm typecheck # проверки TypeScript по всему репозиторию
pnpm test # модульные и интеграционные тесты workspace
Требуются Node.js 22+ и исполняемый файл Codex CLI. Откройте http://127.0.0.1:19861/ после pnpm web:dev; при первом запуске Runtime автоматически подготовит проект по умолчанию, и поле ввода будет готово сразу после установки соединения.
Как внести вклад
- Опишите проблему, сценарий использования и ожидаемое поведение в issue.
- Создайте сфокусированную ветку функции или исправления от последней ветки разработки.
- Следуйте существующей архитектуре: общие возможности продукта реализуются один раз в Web и Daemon, а нативные различия Desktop изолируются за явными capability (например,
canSelectDirectory). - Добавьте соответствующее покрытие модульными, интеграционными или E2E-тестами для изменений поведения и перечислите в PR как выполненные, так и пропущенные проверки.
- Никогда не коммитьте
.runtime/, локальные учётные данные, сессии Codex, кэши сборки или другие пользовательские данные.
Что проверяют ревьюеры
- Единая реализация общего поведения. Одна и та же функция не должна реализовываться отдельно для Browser Bridge и Desktop Bridge.
- Capability gating вместо тихих заглушек. Платформенно-специфичный вход должен скрываться, когда capability недоступна — никогда не показывайте кнопку, которая молча ничего не делает.
- Тесты соответствуют риску изменения. Небольшие правки текста или стилей требуют только точечных проверок; изменения общего состояния, персистентности или контрактов Runtime требуют как минимум модульных тестов и typecheck.
- Документация обновляется вместе с поведением. Если ваше изменение меняет видимый пользователю рабочий процесс, обновите README или соответствующий документ в
docs/в том же PR.
Частые причины возврата PR
- Одна и та же логика добавлена отдельно в путях Web и Desktop вместо общего сервисного слоя.
- Неподдерживаемая платформой кнопка видима, но её обработчик молча возвращается.
- Поведение изменено без тестов или заметки о проверке.
- PR смешивает несвязанный рефакторинг или исправление с основным изменением.
- Закоммичены сгенерированные файлы, данные
.runtime/или учётные данные.
OpenCreator · Create locally, work continuously.