Внесение вклада

Мы всегда рады принимать вклады, чтобы сделать DataHub лучше. Прочитайте этот документ, если вы хотите внести свой вклад.

Отчёт о проблемах

Мы используем GitHub Issues для отслеживания сообщений о багах, запросов на новые возможности и отправки pull request'ов.

Если вы нашли баг:

1. Используйте поиск GitHub для проверки того, был ли уже создан запрос о данной проблеме.

2. Если проблема была исправлена, попробуйте воспроизвести её с помощью последней версии master ветки репозитория.

3. Если проблема все еще возникает или ещё не была открыта, попробуйте изолировать проблему перед тем как создать запрос.

Отправка pull request (PR)

Перед тем как отправить ваш pull request (PR), пожалуйста, учтите следующие рекомендации:

• Поиск GitHub для открытого или закрытого PR, который связан с вашей подачей. Вы не хотите повторять работу.

• Следуйте стандартному подходу GitHub для создания PR. Также следует придерживаться нашего формата сообщений о коммитах.

• Вот и всё! Благодарим вас за ваш вклад!

Формат сообщений о коммитах

Пожалуйста, следуйте спецификациям Conventional Commits для формата сообщений о коммитах. Кратко говоря, каждое сообщение о коммите состоит из шапки, тела и подвала, разделённых одной пустой строкой.

<тип>[необязательный контекст]: <описание>

[необязательное тело]

[необязательный подвал]

Любой строкой сообщения о коммите не может превышать 88 символов! Это позволяет сообщению быть легче читаемым на GitHub, а также в различных инструментах Git.

Тип

Должен быть одним из следующих (на основе конвенции Angular):

• feat: Новая возможность
• fix: Исправление ошибки
• refactor: Изменение кода, которое ни к чему не относится
• docs: Изменения только в документации
• test: Добавление недостающих тестов или корректировка существующих тестов
• perf: Изменение кода, которое улучшает производительность
• style: Изменения, которые не влияют на смысл кода (пробелы, форматирование, отсутствие точки с запятой и т.д.)
• build: Изменения, которые влияют на систему сборки или внешние зависимости
• ci: Изменения в наших файлах конфигурации CI и скриптах

Необязательный контекст может быть предоставлен к типу коммита, чтобы предоставить дополнительную информацию, и содержится в круглых скобках, например,

feat(парсер): добавить возможность парсинга массивов

Описание

Каждый коммит должен содержать краткое описание изменения:

• использовать повелительное наклонение настоящего времени: "изменить", а не "было изменено" или "будет изменено"
• не делать первой буквы заглавной
• не ставить точку в конце

Тело

Как и в описании, используйте повелительное наклонение настоящего времени: "изменить", а не "было изменено" или "будет изменено". Тело должно содержать мотивацию для изменения и противопоставляться предыдущему поведению.

Подвал

Подвал должен содержать любую информацию о разрушительных изменениях и является местом для ссылки на GitHub issues, которые этот коммит Закрывает.

Разрушительные изменения должны начинаться словами BREAKING CHANGE: с пробела или двух новых строк. Оставшаяся часть сообщения о коммите используется для этого.

Откат

Если коммит отменяет предыдущий коммит, он должен начинаться со слова revert:, за которым следует описание. В теле должно быть указано: Refs: <hash1> <hash2> ..., где хэши — это SHA предыдущих коммитов, например,

revert: никогда больше не будем говорить о случае с лапшой

Refs: 676104e, a215868