Quantcast
Channel: Гайдлайны 1312 Inc.
Viewing all articles
Browse latest Browse all 55

Версионность и ченджлоги

$
0
0

Хорошо зарекомендовавшая себя практика версионности и написания ченджлогов для цифровых проектов 1312:

Базовая версия продукта — в формате X.Y.Z. Например, 1.0.0, 3.0.13, 2.10.0.
X поднимается только по очень значимым событиям, например, при смене поколения продукта. Как правило, раз в несколько лет. Повышение версии X всегда обращает на себя особое внимание. X ≥ 1. Ноль можно использовать, только когда нужно явно подчеркнуть, что продукт явно пробный, и использовать его надо на свой страх и риск.
Y — по появлению новой заметной полезной функциональности. Y начинается с нуля.
Z — любые прочие обновления, когда починили что-то сломанное, где-то подкрасили, где-то подчистили. Z тоже начинается с нуля.

Нумерация сборок (билдов) — YYYYMMDDN. Например, 201908153 означает, что это билд №3 от 15 августа 2019 года. Если N за день больше десяти, что на практике в 1312 случалось только один раз за много лет, то можно перескочить на следующее число (201908161; то есть по сути N — цифра, а не число; отсчет N — с единицы).

Ченджлог (запись о том, что было добавлено в обновлении) пишется либо в настоящем, либо в прошедшем времени в зависимости от того, как подсказывает здравый смысл. Важнее сохранять единые стиль форматирования текста, чем писать каждый текст в каком-то фиксированном времени. Например, «исправили что-то сломанное», но «встречайте нечто новое» — абсолютно приемлемо!


Viewing all articles
Browse latest Browse all 55

Trending Articles