Как адаптировать мое управление версиями к Readme Driven Development?

Question

Я хотел бы согласиться с RDD и Breaking.Feature.Fix версией.

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

Вот проблемы, я столкнулся:

• бы переломные изменения в API документирован в README считаются основными? Помните, что в этот момент нет кода.
• Какова должна быть первая версия README? Что такое конвенция?
• Какая часть (майор, малый или патч) должна ли я надавить на первый код? Опять же, до этого у меня только был README.
• Прежде чем совершить первый код, следует ли использовать prerelease tags для моих версий README?

Answer 1

Поскольку вы не обязаны использовать «истинную» RDD, и так как одна из основных предпосылок РДА, что это DDD для людей, которые думают, что DDD слишком тяжелый вес, я бы сказал, взять то, что вы хотите от RDD (и мне нравится идея) и используйте его, и не беспокойтесь, если вы «делаете RDD right».

Что касается ваших конкретных вопросов:

Да, я бы сказал, не имеет обратной совместимости изменения API, безусловно, главная версия шишка (по крайней мере, как только вы получите V1).

Я скромный, я стараюсь начинать все с 0.0.0. - если вы считаете, что ваши первые усилия - общее качество выпуска, эй, пойдите с 1.0.0!

Зависит от суммы внесения изменений.

У меня нет - если вы найдете значение, я бы хотел.

Answer 2

Вот как я это делаю (отредактированный):

Я не версия документации (включая РДУ) отдельно от исполнителя кода. Я всегда запускаю свое программное обеспечение на уровне 1.0.0 и обычно начинаю с документа RDD, который может иметь или не содержать сопроводительный код, в зависимости от сложности реализации.

Я не начинаю натыкаться на номер версии, пока не появится код. Этот подход может не работать, если ваш RDD является спецификацией, и есть другие люди, реализующие вашу документацию. В этом случае вы можете рассмотреть возможность размещения документации в своем собственном репозитории и сохранения собственной истории версий, которая отделена от истории версий реализации программного обеспечения. Если вы поддерживаете их отдельно, ваши правила версий RDD должны соответствовать тем же принципам, что и правила версии программного обеспечения. Breaking.Feature.Fix.

В противном случае, если вы не собираетесь поддерживать отдельное управление версиями для своего RDD, до того, как какой-либо код существует, я думаю, что обычно нормально начинать с 1.0.0, а не увеличивать его до тех пор, пока вы не начнете нажимать исполняемый код. Я бы поместил любые нереализованные документы в папку docs/RDD или подобное, чтобы отличить ее от документации для кода, который был реализован.

Мои оригинальные ответы применяются к версиям кодов, а не документация версии:

• «? Будет ли нарушение изменений в API документированы в README-считается одним из основных» - Да, абсолютно.
• «Какая должна быть моя первая версия?» - Начало в 1.0.0. Номера версий предназначены для программного обеспечения, а не для людей. Каждое нарушение должно быть сообщено с изменением основного номера версии.
• «Какую часть я должен надавить на первый код?» - Ваш первый код должен быть @ 1.0.0.
• «Должен ли я использовать предварительные теги?» - Вы должны пометить свою рекомендуемую стабильную версию как последние. Используйте теги preerelease, если у вас есть экспериментальный кандидат на выпуск, который нуждается в более широком тестировании, но не готов к общему производству.

Подробнее о моих рекомендациях по версии программного обеспечения вы можете узнать в "Software Versions are Broken".