Как выполнить обновление документации по версиям? - PullRequest
0 голосов
/ 17 сентября 2018

Я пишу оболочку REST API и внес важные изменения в документацию.Как мне справиться с этим согласно semver ?Должен ли я обновить свой младший номер версии / патча или полностью игнорировать обновление, так как исходный код не изменился?

1 Ответ

0 голосов
/ 19 сентября 2018

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

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

Если это не относится к изменениям в документации, это изменение уровня патча.

...