Закодированный язык в обзорах кода

Кодированный язык в обзоре кода

Обзор кода — это искусство просмотра изменений кода, опубликованных вами или другими людьми, чтобы их можно было объединить с кодом основного потока. На протяжении многих лет основная ветка называлась главной веткой, пока несколько лет назад она не вызвала «проблемы» и не должна была рассматриваться как основная, основная ветка, ядро ​​ и т. д.

При просмотре кода используются жаргоны языка, на которые стоит обратить внимание. Статья просто фиксирует известное и демистифицирует неизвестное.

Запрос на слияние (PR), запрос на изменение (CR) или запрос на слияние (MR)

Псевдоним запроса на вытягивание PR был де-факто ссылкой для опубликованных изменений, запрашивающих добавление в ветку main. Имя продолжает публиковаться Github, который на данный момент является крупнейшей платформой для размещения кода. Это происходит из-за того, что он запрашивает основную ветку вытащить изменения из вашего форка. "У меня есть кое-какие изменения, можете взять из моей ветки?".

Запрос на изменение (CR) довольно очевиден и технически делает то, что следует из названия. "У меня есть некоторые изменения, и я хотел бы запросить потенциальное включение в основную ветку".

С другой стороны, запрос на слияние (MR) немного более настойчив, поскольку заранее объявляет мотив. "Я запрашиваю слияние с основной веткой??"

Разные компании приняли собственное соглашение, когда речь заходит о намерении внести изменения в исходный код. Обратитесь сюда, чтобы узнать больше о битве.

ЛГТМ

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

Его можно примерно перевести как «Я просмотрел ваш код, и у меня нет никаких проблем, вы можете продолжить и объединить его».

Некоторые могут называть LGTM Давайте объединимся!

нит

Оно происходит от слова придираться, что означает внимание к мельчайшим деталям. Однако в обзоре кода это указывает на предложение, которое важно, но не влияет на слияние изменений.

Другими словами, он подтверждает действие одобрить предложениями. Это также более удобный способ добавления комментариев, в которых в основном требуется, чтобы изменения соответствовали установленным стандартам кода, как показано на примере ниже;

nit: spelling mistake -> newtork 

Другие примеры ищите здесь.

то же самое

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

Изучите код ниже;

class Status(Enum):
    PENDING = 1
    DONE = 2


class StatusChecker:

  def __init__(self, status: Status):
      self.status = status

  def is_pending(self) -> bool:
      if self.status == Status.PENDING:
          return True
      else:
          return False

  def is_done(self) -> bool:
      if self.status == Status.DONE:
          return True
      else:
          return False

Как рецензент, вы можете добавить один и тот же комментарий к функциям is_pending и is_done. Питоническое мышление предложило бы следующее предложение

def is_pending(self) -> bool:
    # comment -> The code can be simplified to return the comparison result
    return self.status == Status.PENDING

def is_done(self) -> bool:
    # comment -> ditto
    return self.status == Status.DONE

ПТАЛ

Одно из правил эффективного ревью кода — сопровождать комментарий или аргумент соответствующей документацией. Ссылка может указывать на официальную документацию пакета, внутреннюю вики, переполнение стека, статью в блоге и т. д.

Пожалуйста, посмотритепсевдоним PTAL, который пригодится, чтобы направить целевую аудиторию к более подробному или всеобъемлющему завещанию.

Мало того, иногда вы можете пометить другого человека, чтобы он посмотрел адресованный комментарий, чтобы узнать его мнение. В этом случае комментарий может следовать за @Erick PTAL.

Насколько мне известно

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

Типичным примером является ситуация, когда конкретная операция или функция объявлены устаревшими в пакете. В этом случае рецензент может добавить комментарий наверное: эта функция скоро станет устаревшей в пользу ‹новой функции›.

Точно так же Если я правильно помню (IIRC)можно использовать взаимозаменяемо.

ИМО/ИМХО

Доброта никогда не может быть переоценена во время проверки кода. Эти сокращения добавляют остроты обзору.

ИМО переводится как, по моему мнению,в то время как его аналог может быть истолкованкак, по моему скромному мнению. Оба используются для того, чтобы поставить точку, не звуча так всезнающе, осуждающе или снисходительно.

Никогда не знаешь, сколько напряжения могут снять эти аббревиатуры!

Пример -› ИМХО, это преждевременная оптимизация

УЦ

UT — это сокращенная форма модульных тестов. При использовании в комментарии к обзору кода может указывать на то, что конкретный сценарий необходимо дополнительно протестировать с различными тестовыми примерами. например, Включить UT для работы с пользователями без роли администратора.

ТБЧ

Другой удобный аббревиатурой является tbh, что может означать быть честным, что является английской фразой, означающей говорить откровенно.

нвм/нм

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

В случае, когда комментарий добавлен в начале обзора, а позже к комментарию были применены изменения, комментатор может добавить nvm в качестве ответа на первый комментарий.

Давайте возьмем это в автономном режиме

Этот комментарий предполагает, что цепочка комментариев может быть запутанной, что приводит к недопониманию. Поэтому лучше обсудить это более подробно по телефону со всеми заинтересованными сторонами.

Заключение

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