docs.gemforge.ru

Соглашения по оформлению и форматированию кода, повышение качества

Этот раздел посвящён техническим деталям и конвенциям, направленным на повышение качества разработки.

Экология GitHub

Работайте в отдельной ветке с осмысленным названием и затем предлагайте pull request, перечислив внесённые изменения. Пример названия: “alexeyshadow/GLS-18”. Где alexeyshadow - идентификатор разработчика, GLS-18 - карточка на разработку функционала или баг из Youtrack.

Сделайте регулярный pull хорошей привычкой.

Пишите осмысленный commit, где указано краткое описание изменений. Пример:

  1. Исправил баг GLS-17
  2. Исправил баг GLS-21
  3. Добавил кнопку “Login” на страницу “Блог”

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

Форматирование

Используейте в работе Prettier. Настройки Prettier используются по умолчанию.

Сделайте регулярное форматирование кода второй хорошей привычкой.

Комментирование

Не добавляйте комментарий в конце строки с выражением, а разместите его перед строкой.