aswi2023brainstorm-gitlab/doc/internal/doc.tex @ b6218b32

\documentclass[12pt, a4paper]{article}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%-----------------------VYUŽITÉ PACKAGES----------------------------%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\usepackage[czech]{babel}
\usepackage{geometry}
\usepackage[final]{graphicx}
\usepackage{anyfontsize}
\usepackage{setspace}
\usepackage{hyperref}
\usepackage[T1]{fontenc}
\usepackage{subcaption}
\hypersetup{
    colorlinks,
    citecolor=black,
    filecolor=black,
    linkcolor=black,
    urlcolor=black
}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%-----------------------ZAČÁTEK VLASTNÍHO TEXTU---------------------------%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{document}

\begin{titlepage}
    \title{
        \vspace{-4cm}\hspace{-10cm}
        \includegraphics[width=8cm]{assets/logo.png} \\
        \vspace{5cm}
        \begingroup
        \setstretch{4}\fontsize{30}{10}\selectfont\fontdimen2\font=0.8ex
        \parbox{13.3cm}{
            \centering{\textbf{ASWI - Neurorehablitační systém BrainIn}\\
                \fontsize{24}{10}\selectfont\centering{{Interní týmové předpisy a dokumentace}}
            }}
        \endgroup}
    \date{}
    \author{}
    \maketitle \thispagestyle{empty}
    \vspace{3cm}
    \hspace{0cm}\parbox[b][5cm][b]{8cm}{{\setstretch{1.5}
                Autor: Bc. Jan Hereš\\
                Datum: 27.02.2023\\
                Poslední úprava: \today\\}}
\end{titlepage}
\newpage


\tableofcontents
\newpage

\section{Úvod}
\paragraph{} Tento dokument slouží jakožto analogie ,,interních směrnicí'' pro sjednocení a ustálení vývojových procesů napříč celým týmem.

\section{Interní management}
\paragraph{} V rámci řízení projektu bylo ustanoveno, že se tým bude \textbf{pravidelně} scházet v on-site/online formě každý týden (konkrétní den bude vždy určen s předstihem dle možností jednotlivých zúčastněných). V rámci těchto schůzek bude probrána odvedená a naplánovaná práce, případně jakákoliv nastávající problematika. Z těchto meetingů bude \textbf{vždy} vytvořen ,,záznam ze schůzky dne XXX'', který bude součástí dokumentu se všemi takovými záznamy.

\section{Verzovací systém Git}
\paragraph{} Tato sekce se týká verzovacího systému Git (potažmo repozitáře Gitlab).


\subsection{Tvorba vývojových větví (\textit{branches})}
\paragraph{} V rámci projektu existuje hlavní vývojová větev \textbf{master}.
V této větvi budou dostupné veškeré \textbf{funkční a otestované} verze projektu ve formě otagovaných \textbf{releases}.
Nadále bude existovat větev \textbf{development (dev)}, na které bude dostupná \textbf{poslední upravená, funkční a otestovaná}(na dev prostředí) verze, jež nebyla ještě otestována na produkčním prostředí.
Ve chvíli, kdy bude verze na development větvi otestována i na produkčním prostředí, může být vytvořen merge request do hlavní větve (za předpokladu, že jsou splněny všechny požadavky na novou verzi).
Pro nové \textit{features} nebo pro \textit{change requests} bude vždy vytvořena \textbf{nová} separátní větev z development větve.
Workflow mezi jednotlivými větvemi je vyobrazen na obrázku \ref{fig:branches_workflow}.

\begin{figure}[h]
    \centering
    \includegraphics[width=\linewidth]{assets/aswi_branches.png}
    \caption{Workflow mezi jednotlivými větvemi v rámci repozitáře}
    \label{fig:branches_workflow}
\end{figure}


\subsection{Tvorba a správa úkolů napříč používanými nástroji}

\subsubsection{Issues}
\paragraph{} Issue je základní plánovací jednotka v systému řízení projektu (zde konkrétně nástroj \textbf{Jira}).
Tato jednotka bude vždy svázána s konkrétní \textit{issue} na repozitáři Gitlab, tzn. v rámci \textit{issue} bude \textbf{vždy} k dispozici odkaz na danou \textit{issue} v repozitáři. Jejich vazba by tedy vždy měla být 1:1.

\subsubsection{Ticket}
\paragraph{} Ticket je běžný základní úkol.
V rámci každé issue bude k dispozici výčet všech podúkolů (\textit{task}) které je nutné v rámci daného ticketu splnit.
V rámci \textit{issue} bude taktéž možné specifikovat, zda-li úkol čeká na dokončení jiného, či naopak.

\subsubsection{Feature}
\paragraph{} Feature je typ \textit{issue} využívaný k označení implementace nové funkcionality do aplikace.

\subsubsection{Bug}
\paragraph{} Bug je typ, kterým se označují úkoly spojené s odstraněním nových vzniklých chyb během vývoje.

\subsubsection{Change request}
\paragraph{} Tímto type se označují úkoly, které jsou spojené se změnou nějaké již implementované funkcionality (feature), nicméně během vývoje došlo ke změnám priorit zákazníka a je potřeba tuto funkčnost upravit/změnit.

\subsubsection{Epic}
\paragraph{} Epicy jsou velké logické celky agregující jednotlivé, logicky spjaté \textit{issues}.
V rámci jedné iterace je možné mít naplánováno více Epiců a jeden Epic může být součástí více iterací.

\subsubsection{Obecná pravidla pro vytváření \textit{issues}}
\begin{itemize}
    \item Každá \textit{issue} bude obsahovat krátký, nicméně dostatečně deskriptivní popis, čeho konkrétně se týká
    \item Každá \textit{issue} bude \textbf{jednoznačně identifikovatelná} za pomocí tzv. \textbf{labelů} (specifikováno dále)
    \item Každá \textit{issue}, která bude v jiné, než \textbf{Backlog} fázi (specifikováno dále) bude \textbf{jednoznačně přiřazena} danému vývojáři (případně testerovi či zákazníkovi, bude-li třeba)
    \item Každá \textit{issue} bude označena jednou z možností \textbf{,,priority''} (viz dále)
    \item U každé issue, které je ve fázi ,,In progress'', či dále, by měl být stanoven časový odhad potřebné práce k dokončení.

\end{itemize}

\subsubsection{Možné fáze \textit{issues}}
\begin{itemize}
    \item Backlog - analogie s TODO
    \item In progress
    \item To test (dev) - testování \textbf{vždy provádí jiný vývojář(tester)!}
    \item Code review
    \item To deploy (dev) - funkcionalita implementována, nicméně je nutné funkční verzi \textit{deploynout} na testovací prostředí k umožnění testování
    \item To test (prod) - otestování na produkčním prostředí
    \item To deploy (prod) - končí schválením merge requestu do \textbf{masteru}
    \item Done - Issue hotova, uzavřena
\end{itemize}

\paragraph{} Poznámka: Ze stavu ,,To deploy (dev)'' lze přejít do stavu ,,Done'', pokud není žádoucí ovlivňovat produkční prostředí (zejména pro malé změny, které jsou součástí většího zásahu do projektu).


\paragraph{Typy issues}
\begin{itemize}
    \item Epic - velký logický blok, který obaluje novou funkcionalitu nebo velké množství úprav
    \item Feature - nová funkcionalita (zejména front-endové změny)
    \item Ticket - jakýkoliv další úkol, který implicitně není novou funkcionalitou, spíše například vytvoření obsáhlejší dokumentace, případně nových tříd či struktur
    \item Task - základní úkol (ideálně atomický); využití na rozdělení ticketu do menších podúkolů
    \item Bug - Chyba, kterou je nutno opravit
    \item Change request - vyžádaná změna od zákazníka/uživatele, která byla již dříve implementována
\end{itemize}

\paragraph{Typy priority}
\begin{itemize}
    \item \textbf{Lowest}
    \item \textbf{Low} - nevyžaduje velkou pozornost (příkladem mohou být nekritické části aplikace, ,,nice to have(s)''),
    \item \textbf{Medium} - vyžaduje vyšší míru pozornosti - již by neměly zůstávat nedokončeny v rámci přiřazené iterace (v krajních případech je možné posunout do další),
    \item \textbf{High} - vysoká priorita vyžadujicí privilegované řešení,
    \item \textbf{Highest (Severe)} - maximální důležitost - vyžaduje okamžité řešení (například v případech, kdy tyto problémy způsobují nestabilitu či přímo rozbíjí produkční prostředí)
\end{itemize}

\paragraph{} V rámci jakýchkoliv úkolů \textbf{není potřeba} vést časové údaje a odhady. Tato činnost bude probíhat v systému \textbf{Jira}.


\section{Aplikace pro řízení projektů - Jira}
\paragraph{} Pro účely předmětu ASWI bylo schváleno garantem předmětu doc.Ing. Přemyslem Bradou, MsC., Ph.D. a vedoucími projektu použití nástroje \textbf{Jira} pro správu vývoje a projektu.
Pro sjednocení vývojového procesu byl vytvořen následující projektový workflow:

\begin{figure}
    \centering
    \includegraphics[width=\linewidth]{assets/jira_workflow.png}
    \caption{Projektový workflow v systému Jira}
\end{figure}

\paragraph{} Poznámka: Je tedy zřejmé, že tento workflow přesně koreluje s navrženou stukturou repozitáře projektu.


% \cite{Example}


% \clearpage
% \section{Závěr}

% \newpage
% \bibliographystyle{unsrt}
% {\raggedright\small
% \bibliography{literatura}
% }

\end{document}