LINUX.ORG.RU

Формат для комментов ревью кода

 , ,


1

2

Существует ли открытый сабж в природе или только чуваки из altassian доперли что это круто?

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

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

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

Хотелось бы услышать ваше ненужно мнение по следующим вопросам:

  • Какая информация должна в итоге сохраняться?
    • Судя по всему должен быть текст коммента
    • Нужна ли дата?
    • Наверное было бы неплохо знать кто недоволен?
    • Что то ещё?
  • Можно ли как то всё это дело встроить в форматы поддерживаемые diff не ломая совместимость?
  • Как бы выглядел такой формат, при всех прочих требованиях, какой набор стандартных утилит был бы нужен для работы с ним?

ненужное ненужно.

  • программа пишется для людей на языке понятном машине,
  • коменты пишутся для людей на языке понятном людям.

де-факто в правильный коммент уходит то что не формализуется в рамках ЯП, но имеет место быть.

если начать формализовать комментарии, то появятся уберкоменты, которые выбиваются из навязанного формализма, но более понятны и именно ими будут пользоваться люди. То есть масло-маслянное.

MKuznetsov ★★★★★ ()
Ответ на: комментарий от val-amart

если что, речь о комментариях к code review

уже заметил, но останусь при собственном мнении, что они там совсем о@#$@ли - пусть слово останется словом.

MKuznetsov ★★★★★ ()
Ответ на: комментарий от MKuznetsov

Так то если оно не хуман ридабл, о чем я кстати написал, оно естественно не нужно. Насчет human writable, тут можно подискутировать. Насколько с вашей точки зрения не human writable markdown?

А вот если это читается хотя бы с тем же усилием что и патч, плюс написание сих комментов легко автоматизируется с помощью какого нибудь meld.
То имхо это решает 2 задачи как минимум - собственно упрощает жизнь разработчикам различных гитлабов, т.к. формат в котором храниться ревью общий и открытый и не надо запариваться со своей реализацией. Ну и позволяет командам меньше привязываться к конкретному инструменту для ревью. Которые, как можно прочитать в параллельном топике, вполне могут оказаться недоступны.

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

batbko ()
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.