Skip to content

Commit

Permalink
ENH: Add git commit messages
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinThoma committed Aug 14, 2018
1 parent cdcae56 commit f2fc6ca
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 1 deletion.
2 changes: 1 addition & 1 deletion presentations/software-engineering-basics/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ make:
make clean

clean:
rm -rf $(TARGET) *.class *.html *.log *.aux *.out *.glo *.glg *.gls *.ist *.xdy *.1 *.toc *.snm *.nav *.vrb *.fls *.fdb_latexmk *.pyg
rm -rf $(TARGET) *.class *.html *.log *.aux *.out *.glo *.glg *.gls *.ist *.xdy *.1 *.toc *.snm *.nav *.vrb *.fls *.fdb_latexmk *.pyg _minted-software-engineering-basics/
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,44 @@ \subsection{A subsection!}
Namespaces are one honking great idea -- let's do more of those!
\end{frame}


\begin{frame}{commit messages}
\begin{columns}
\begin{column}{0.5\textwidth}
\begin{itemize}[<+->]
\item Can I understand what the commit was about?
\item Use prefixes
\item Mention issues
\end{itemize}
\end{column}
\begin{column}{0.5\textwidth}
\only<1>{cleanup, fixed bug, new feature, \dots}
\only<2>{

\begin{itemize}
\item BUG: bug fix
\item DEV: development tool or utility
\item DOC: documentation
\item ENH: Enhancement, a new feature
\item MAINT: Maintenance task
\item REL: release
\item STY: Stylistic change
\item TST: addition or modification of tests
\end{itemize}

Source: \href{https://docs.scipy.org/doc/numpy-1.13.0/dev/gitwash/development_workflow.html}{Scipy Development Workflow}
}
\only<3>{
\begin{itemize}
\item See issue \#123
\item Closes issue \#123
\end{itemize}
}
\end{column}
\end{columns}
\end{frame}


\begin{frame}{commit squashing}
\begin{columns}
\begin{column}{0.5\textwidth}
Expand Down

0 comments on commit f2fc6ca

Please sign in to comment.