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

Мы используем pnpm для разработки. Пожалуйста, убедитесь, что у вас на компьютере установлены node.js, npm и pnpm.

После клонирования Milkdown выполните команду pnpm install для установки зависимостей. Затем вы можете выполнить несколько команд:

• pnpm watch отслеживает все пакеты, кроме gh-pages.
• pnpm clear удаляет все сборки dist.
• pnpm test:unit запускает юнит-тесты.
• pnpm test:it запускает интеграционные тесты.
• pnpm test:lint проверяет стиль кода.
• pnpm test:tsc запускает проверку типов в TypeScript.
• pnpm test запускает все возможные тесты.
• pnpm doc запускает режим разработки для пакета gh-pages.
• pnpm build:packs выполняет сборку всех пакетов.
• pnpm build:doc выполняет сборку пакета gh-pages.
• pnpm commit выполняет фиксацию с помощью git hooks.

Самый простой способ начать — запустить pnpm watch в одной командной строке и pnpm doc в другой. Затем вы можете внести изменения, которые хотите увидеть.

Предварительная проверка

Прежде чем создавать запрос на вытягивание, пожалуйста, проверьте следующее:

• Пройдены предварительные коммитные хуки, пожалуйста, не игнорируйте их.
• Успешно пройден pnpm test.
• Успешно выполнен pnpm build:packs.
• Успешно выполнен pnpm build:doc.
• Работает так, как ожидалось, pnpm doc:preview.

Лицензия

Внося свой вклад в Milkdown, вы соглашаетесь, что ваши вклады будут лицензироваться по лицензии MIT.