Skip to content
Snippets Groups Projects
Commit 4f96b1fa authored by Philippe Dosch's avatar Philippe Dosch
Browse files

Add recommandations about how to define logs

parent be7096ab
No related branches found
No related tags found
No related merge requests found
......@@ -823,14 +823,33 @@
\item
Intuitivement, doit être proche d'un résumé ($\sim$ une phrase)
que l'on pourrait faire à un \emph{collègue} (initié donc~!)
\end{itemize}
}
%======================================================================
\frame{\frametitle{Que mettre dans un log ?}
\framesubtitle{Et dans l'intention...}
\begin{itemize}
\item
Recommandations supplémentaires (bonnes pratiques)
\begin{itemize}
\item
S'en tenir à 1 phrase pour la description courte
\item
Utiliser une majuscule en début de phrase
\item
Utiliser la forme impérative («~corrige le bug...~» plutôt que
«~bug... corrigé~» ou «~correction du bug...~»)
\end{itemize}
\item
Exemples
\begin{itemize}
\item
Remplacement de conditionnelles imbriquées en \ex{switch} pour
Remplace les conditionnelles imbriquées en switch pour
améliorer la lisibilité (forme)
\item
Suppression de la fonctionnalité DDFD\_08 entravant la stabilité
Supprime la fonctionnalité DDFD\_08 entravant la stabilité
du code (fond)
\end{itemize}
\end{itemize}
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment