Лучшие практики для управления версиями
6 мая 2023 г.Управление версиями программного обеспечения позволяет быстро определить состояние API, пакета или программного продукта путем присвоения уникального имени и/или номера. Версии помогают заинтересованным сторонам отслеживать изменения кода с течением времени. Существует несколько различных типов схем управления версиями, наиболее популярным из которых является семантическое управление версиями (SemVer), предложенное Томом Престоном-Вернером в 2013 году.
Независимо от того, какую схему управления версиями вы используете для отслеживания изменений в своем программном обеспечении, существуют некоторые принципы и передовые методы управления версиями, которым разработчики могут следовать, чтобы выпуски программного обеспечения проходили максимально гладко. В этом уроке по программированию мы обсудим некоторые из них.
Прежде чем читать наши рекомендации по управлению версиями, вы можете ознакомиться с учебным пособием: Что такое управление версиями?
Сообщите пользователям, какую схему управления версиями вы используете
Большинство пользователей практически ничего не знают о схемах управления версиями, поэтому вам следует сообщить им, какую схему вы используете, что она означает и где они могут найти дополнительную информацию о ней. Есть несколько способов сделать это. Например, вы можете включить его в свою документацию или поделиться сведениями о версиях через свой список рассылки или другие регулярные сообщения компании. В любом случае, информирование пользователей о вашей схеме управления версиями поможет им управлять своими ожиданиями и не удивляться и не тревожиться всякий раз, когда номер версии изменяется и/или увеличивается. Напротив, пренебрежение информированием пользователей о вашей схеме управления версиями может привести к множеству ненужных обращений в службу поддержки, особенно при выпуске новой версии.
Ведение открытого списка релизов и изменений
Подумайте о некоторых программах, которые вы используете регулярно, и есть очень большая вероятность, что есть опубликованный график выпуска, относящийся к ним, скорее всего, веб-страница на сайте компании. Например, вот график выпуска Mozilla для браузера Firefox:
Изображение предоставлено Mozilla.org
Нажав на ссылку версии, вы попадете на страницу с дополнительной информацией об этом конкретном выпуске, включая дату выпуска, что нового, исправления, изменения, информацию для разработчиков и многое другое.
Есть и другие важные сведения, которыми вы можете поделиться со своими пользователями, например, кодовое имя и запланированная дата окончания срока службы (EOL) каждого выпуска, если это применимо. Последнее особенно полезно для пользователей, поскольку может помочь им спланировать расходы и выделить время и ресурсы для обновления до последующих версий.
Будьте последовательны и предсказуемы, когда это возможно
Никто не любит сюрпризов, поэтому чем больше пользователей знают, чего и когда ожидать, тем лучше. При этом, если вы можете придерживаться заранее определенного графика выпуска, сделайте это. Более того, если вы определитесь с запланированным графиком выпуска вашего программного обеспечения, придерживайтесь его! Возможно, вы захотите дважды подумать, прежде чем выпускать релиз раньше, только потому, что вы готовы досрочно, или, что более вероятно, решили отложить некоторые обновления до будущего релиза. Вместо того, чтобы обрадоваться, пользователи могут на самом деле разозлиться и начать рассматривать другие варианты продукта. Причина в том, что игнорирование вашего графика выпуска подрывает доверие, которое вы установили со своими пользователями, и в первую очередь сильно подрывает преимущества наличия системы управления версиями.
Согласованность и предсказуемость также применимы к вашим именам версий. Хотя это не проблема для семантического управления версиями, другие схемы именования могут со временем запутаться. Хорошим (плохим?) примером этого может быть Microsoft, чьи соглашения об именах для Windows, похоже, меняются случайным образом. Сначала были 1, 2 и 3, но потом внезапно без предупреждения перешли на год 95, 98 и 2000. Но почему-то был выпуск между 98 и 2000 под названием NT. После 2000 года Microsoft таинственным образом вернулась к собственным именам для XP и Vista, прежде чем, наконец, снова перейти к числовым прозвищам для 7, 8 и 10.
Если разработчики не забудут, чтобы их названия версий были скучными, а их продукты — интересными, они никогда не ошибутся!
Спросите своих пользователей об их мнении
После того как разработчики программного обеспечения приняли схему управления версиями для своей организации, как они узнают, что она работает оптимально? Если вы не спросите своих пользователей, вы никогда не сможете знать наверняка. Не просто предполагайте это, потому что вы используете семантическое управление версиями, и никто не жаловался, что все хорошо. По причинам, которые могут быть вам неизвестны, семантическое управление версиями может быть не идеальным для вашего продукта или пользователей. Возможно, есть лучший вариант, который вы не рассмотрели.
Даже если ваша схема управления версиями программного обеспечения является «правильной», ваши пользователи могут многое сказать по таким темам, как планирование, поиск сведений о выпуске и, возможно, по множеству других проблем, о которых вы даже не задумывались. Поскольку ваше программное обеспечение разработано с мыслью о пользователях, почему бы не дать им высказаться? Это может только помочь повысить заинтересованность пользователей и дать им почувствовать, что они являются частью процесса разработки.
Везде, где программисты размещают информацию о выпуске, это хорошее место для получения мнений и вопросов от пользователей, включая список выпусков и страницы изменений, а также сообщения по электронной почте. Также не забывайте о социальных сетях; это идеальный форум для начала обсуждения выпусков программного обеспечения.
Заключительные мысли о передовых методах управления версиями
В этом учебном пособии по программированию представлены лишь несколько рекомендаций по управлению версиями, которым вы можете следовать, чтобы ваши выпуски проходили как можно более гладко. По сути, все сводится к тому, чтобы сообщить пользователям о ваших целях и предоставить им максимальную ясность и прозрачность. Когда вы сомневаетесь, больше информации всегда предпочтительнее, чем немного или ничего.
Оригинал