From 84ab31040e4bf55e2f6559b5758fea0d0cee84c1 Mon Sep 17 00:00:00 2001 From: Doc Date: Sun, 16 Feb 2020 16:44:10 +0000 Subject: [PATCH] p11862 Documentation. --- srcx/doc/changes.adoc | 1 + srcx/doc/project.adoc | 36 ++++++++++++++++++++++-------------- 2 files changed, 23 insertions(+), 14 deletions(-) diff --git a/srcx/doc/changes.adoc b/srcx/doc/changes.adoc index aedc0d6..70ec84d 100644 --- a/srcx/doc/changes.adoc +++ b/srcx/doc/changes.adoc @@ -9,6 +9,7 @@ == Лог изменений [square] +* <> Долгоживущие GIT ветки. * <> Множество дополнений в описании проекта для разработчиков: архитектура, workflow, стек технологий. * <> Уточнены настройки MySQL при установке. * <> Создание тестовой БД для разработчиков. diff --git a/srcx/doc/project.adoc b/srcx/doc/project.adoc index 5b92fde..4f27ed7 100644 --- a/srcx/doc/project.adoc +++ b/srcx/doc/project.adoc @@ -221,14 +221,14 @@ BGERP запускается в IDE, с подключением к удалён |Изменение программы и документации. |<> -|*documentation* +|*p11862-documentation* |master -|Корректировки документации. Долгоживущая ветка, периодически переносится на master. +|Корректировки документации. <>, периодически переносится на master. |<> |*documentation-change-request* -|documentation -|Предложения по корректировке документации, могут быть смерджены обратно на documentation. +|p11862-documentation +|Предложения по корректировке документации, могут быть смерджены обратно на p11862-documentation. |<> |=== @@ -290,16 +290,7 @@ git remote prune origin git fetch origin master:master ---- -[[documentation]] -=== Документация -Исходные файлы в формате AsciiDoctor размещаются в каталоге *srcx/doc* проекта. -Модификация исходных кодов программы и документации выполняется одновременно в ветке <>. -Примеры форматирования и рекомендации можно посмотреть <>. -Документация может быть <> локально с ветки и <> в пакет обновления. - -Публикация документации <> с ветки <> *documentation*. -Для предложения больших правок следует создать префиксом *documentation-*, начинающуюся с данной. - +[[accept]] === Приёмка и перенос При принятии изменения производится сравнение ветки с основной. Поэтому перед передачей изменения необходимо смерджить на ветку актуальное состояние основной. @@ -326,6 +317,23 @@ git push Периодически с основной ветки <>. +[[longlife-branch]] +=== Долгоживущие ветки +В долгоживущих ветках производятся изменения *не влияющие на функциональность продукта*. +Как-то: корректировка локализации, документации, форматирование кода, тесты. +Процесс изменения при этом не закрывается, а <> производится многократно по мере готовности очередной порции изменений. + +[[documentation]] +==== Документация +Частным случаем долгоживущей ветки является документация. +Исходные файлы в формате AsciiDoctor размещаются в каталоге *srcx/doc* проекта. +Модификация исходных кодов программы и документации выполняется одновременно в ветке <>. +Примеры форматирования и рекомендации можно посмотреть <>. +Документация может быть <> локально с ветки и <> в пакет обновления. + +Публикация документации <> с ветки <> *p11862-documentation*. +Для предложения правок документации следует создать ветку, начинающуюся с данной. + == Архитектура BGERP представляет из себя standalone Java приложение с динамическим Web интерфейсом. Запуск во время разработки может быть <> прямо в IDE. -- GitLab