Правила внесения вклада

Спасибо за ваше ценное время. Ваши вклады сделают этот проект лучше! Перед подачей вклада, пожалуйста, потратите немного времени на чтение руководства для начинающих ниже.

Семантическая версионирование

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

Каждое значительное изменение будет зафиксировано в файле changelog.## Подача запроса на вытягивание (pull request)

1. Создайте форк этого репозитория и создайте ветку из main. Для реализации новых функций, подайте запрос на вытягивание (pull request) в ветку feature. Для других изменений, подайте запрос на вытягивание (pull request) в ветку main.
2. Установите инструмент pnpm с помощью команды npm install pnpm -g.
3. Установите плагин Eslint для VSCode, или включите функциональность eslint для других редакторов, таких как WebStorm.
4. Выполните pnpm bootstrap в корневой директории.
5. Выполните pnpm install в директории /service/.
6. Внесите изменения в кодовую базу. Если необходимо, убедитесь, что соответствующие тесты выполнены.
7. Выполните pnpm lint:fix в корневой директории для проверки форматирования кода.
8. Выполните pnpm type-check в корневой директории для проверки типов.
9. Подайте коммит git, следуя Руководству по коммитам.
10. Подайте запрос на вытягивание (pull request). Если есть соответствующий запрос на исправление (issue), пожалуйста, свяжите его с помощью ключевого слова для связи запроса на вытягивание с запросом на исправление.## Руководство по коммитам

Сообщения коммитов должны следовать стандарту conventional-changelog:

<type>[optional scope]: <description>

[optional body]

[optional footer]

Типы коммитов

Вот список типов коммитов:

• feat: Новая функция или функциональность
• fix: Исправление ошибки
• docs: Обновление документации
• style: Обновление стиля кода или компонента
• refactor: Переработка кода, без введения новых функций или исправлений ошибок
• perf: Оптимизация производительности
• test: Единичный тест
• chore: Другие коммиты, которые не изменяют файлы src или test

Лицензия

MIT