Прийняті патерни іменування в репозиторіях

Git — надзвичайно гнучка система. Для спрощення процесу перекладу та ревю ми вирішили сформулювати певні правила іменування сутностей в git. Також пізніше це дасть нам можливість генерувати список останніх змін повністю автоматично.

За основу ми взяли conventional commits.

Структура коміт-повідомлення

Назви комітів записуємо у такому форматі:

тип зміни(контекст): опис зміни

За типом, всі зміни до кодової бази репозиторію ми поділяємо на такі групи:

  • translation (переклад новий статей)
  • update (оновлення застарілих статей)
  • fix (виправлення проблеми чи вади в перекладі, чи функціоналі)
  • feature (додатковий функціонал — здебільшого використовується в коді платформи, а не в перекладах)
  • chore (рутинна: оновлення внутрішньої документації, залежностей — щось, що не повинно йти в список змін)

В дужках одразу за типом коміту вказується область чи контекст. Якщо зміна стосується перекладу, там доцільно вказувати розділ, як от: CSS, JS, HTML, SVG. Якщо зміна надто загальна — контекст можна опустити.

Наприклад:

translation(js): /docs/Web/JavaScript/Reference/Global_Objects/Map
update: add alt texts to several images across the whole project
chore: port web/index file from html to md

Найменування гілок

Найменування гілок повинно дублювати структуру коміт-повідомлення. Але вказувати повне повідомлення не потрібно, достатньо якось скороченого запису, який просто дозволяє однозначно зрозуміти, що це за зміна. З поправкою на відсутність пробілів, оскільки в середовищі терміналу з пробілами незручно працювати.

тип-зміни/скорочений-опис-зміни

Наприклад:

translation/jsref-globals-map-index
chore/port-web-index-page-to-md