Участие в проекте GrapesJS

Спасибо за ваш интерес к участию в проекте GrapesJS! Мы приветствуем все виды вкладов, включая отчеты о багах, предложения по функциям, улучшения документации и вклады в код.

Быстрый старт

Предварительные требования

• Node.js (версия 20 LTS)
• pnpm (версия 9.10.0 или выше)

Настройка

1. Установите Node.js 20 LTS:

   nvm install 20
   nvm use 20

2. Установите pnpm глобально:

   npm install -g pnpm@9.10.0

3. Клонируйте репозиторий:

   git clone https://github.com/GrapesJS/grapesjs.git
   cd grapesjs

4. Установите зависимости:

   pnpm install

5. Запустите скрипт сборки:

   pnpm run build

6. Запустите сервер разработки:

   pnpm start

7. Откройте http://localhost:8080/ в вашем браузере, чтобы увидеть редактор в действии.

Процесс разработки

• Линтинг: pnpm lint
• Форматирование: pnpm format
• Проверка формата: pnpm format:check
• Сборка: pnpm build
• Тестирование: pnpm test

Стиль кода

Мы используем ESLint для линтинга и Prettier для форматирования кода. Хотя у нас нет предкоммитных хуков, мы настоятельно рекомендуем использовать эти инструменты перед отправкой ваших изменений:

• Запустите pnpm lint, чтобы проверить наличие ошибок линтинга.
• Запустите pnpm format, чтобы автоматически форматировать ваш код.
• Запустите pnpm format:check, чтобы проверить, правильно ли форматирован ваш код.Стиль кода контролируется на уровне CI. Мы рекомендуем использовать расширения Prettier в вашем редакторе для реального времени форматирования.

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

Чтобы сгенерировать и просмотреть документацию:

1. Сгенерируйте документацию API:

   pnpm run docs:api

2. Запустите сервер документации VuePress:

   pnpm run docs

3. Откройте http://localhost:8080/, чтобы просмотреть документацию.

Пулл-запросы

При отправке пулл-запроса:

• Направьте ваш пулл-запрос в ветку dev.
• Ясно опишите проблему и решение.
• Включите соответствующий номер задачи, если применимо.
• Добавьте тесты для новых функций или исправлений ошибок.

Если вы новичок в проекте, рассмотрите возможность начала обсуждения или открытия задачи, связанной с вашими изменениями, перед отправкой пулл-запроса. Это помогает с кооперацией и предотвращает дублирование работы.

Вопросы?

Если у вас есть вопросы, пожалуйста, откройте задачу или начните обсуждение. Сначала поищите существующие задачи и обсуждения, чтобы избежать дублирования.

Благодарность

Ваши вклады в открытые исходные коды, независимо от их размера, делают проекты, такие как GrapesJS, возможными. Спасибо за то, что вы уделяете время для вклада.