03_discussion presentation

PacificCommunity · Apr 13, 2022 · f625d5b · f625d5b
1 parent 47f2851
commit f625d5b
Show file tree

Hide file tree

Showing 2 changed files with 129 additions and 0 deletions.
diff --git a/slides/03_discussion/03_discussion.pdf b/slides/03_discussion/03_discussion.pdf
diff --git a/slides/03_discussion/03_discussion.tex b/slides/03_discussion/03_discussion.tex
@@ -0,0 +1,129 @@
+\documentclass[aspectratio=169]{beamer}
+\usepackage{spc}
+\begin{document}
+
+\begin{frame}
+  \title{\darkblue 3 ~ Discussion Points}
+  \author{\darkgray\bf Arni Magnusson\\
+    \phantom{.}\h{32ex}\includegraphics[width=1cm]{github_logo}}
+  \date{\darkgreen SPC Git/GitHub Workshop\\[0.5ex]
+    Noumea, 13 April 2022}
+  \titlepage
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}{Overview}
+  \begin{itemize}
+    \item[] \hyperlink{habits}{\bf\darkblue Good habits}
+    \comment{commit early and often, keep commits small, commit messages,\\
+      \h{17ex}keep a light repo, pull before making changes}\\[5ex]
+    \item[] \hyperlink{collaboration}{\bf\darkblue Collaboration}
+    \comment{multiple contributors, merge conflicts, plumbing analogy,\\
+      \h{18.3ex}communication, forks, branches, pull requests}\\[5ex]
+    \item[] \hyperlink{folders}{\bf\darkblue Repo organization}
+    \comment{separate folders vs. repos vs. forks vs. branches,\\
+      \h{23.6ex}main git folder}\\[5ex]
+    \item[] \hyperlink{spc}{\bf\darkblue SPC workflows}
+    \comment{github vs. penguin vs. onedrive vs. c-drive vs. virtual machine,\\
+      \h{20ex}open science, reproducible analyses, regional/global
+      collaboration}\\[1ex]
+  \end{itemize}
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}\Large
+  \hypertarget{habits}
+  \centering\darkgreen\bf
+  Good Habits
+\end{frame}
+% ______________________________________________________________________________
+
+\begin{frame}{Good Habits}\small
+  \vspace{4ex}
+  {\bf\darkgreen Commit early and often}
+  \begin{itemize}
+    \item[-] Create repo and first commits as soon as you begin working on
+    something new\\[1ex]
+    \item[-] Keep each commit small
+    \comment{\fns so it can be described with a short commit message}\\[1ex]
+  \end{itemize}
+  \vspace{6ex}
+  {\bf\darkgreen Write descriptive commit messages}\\
+  \begin{itemize}
+    \item[-] Relatively short, around 60 chars
+    \item[-] Describing purpose or specific things that were changed
+  \end{itemize}
+  \vspace{4ex}
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}{Good Habits (cont)}\small
+  \vspace{4ex}
+  {\bf\darkgreen Keep a light repo}\\
+  \begin{itemize}
+    \item[-] Usually under 1 GB
+    \item[-] Avoid including a large file that will change
+    \item[-] General idea with repos is not to include output files
+    \item[-] {\it Release assets} are a good approach to attach heavy files while
+    keeping the repo light
+  \end{itemize}
+  \vspace{6ex}
+  {\bf\darkgreen Pull before making changes}\\
+  \begin{itemize}
+    \item[-] To make sure you're adding to the current state of the repo
+    \item[-] Avoiding merge conflicts
+  \end{itemize}
+  \vspace{4ex}
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}\Large
+  \hypertarget{collaboration}
+  \centering\darkgreen\bf
+  Collaboration
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}{Collaboration}\small
+  \vspace{4ex}
+  {\bf\darkgreen Multiple contributors}\\
+  \begin{itemize}
+    \item[-] Merge conflicts
+    \item[-] Plumbing analogy
+    \item[-] Communication
+  \end{itemize}
+  \vspace{6ex}
+  {\bf\darkgreen Pull requests}\\
+  \begin{itemize}
+    \item[-] Forks, branches
+    \item[-] Submitting and handling pull requests
+  \end{itemize}
+  \vspace{4ex}
+\end{frame}
+
+% ______________________________________________________________________________
+
+\begin{frame}{Summary}
+  \begin{itemize}
+    \item[] \hyperlink{habits}{\bf\darkblue Good habits}
+    \comment{commit early and often, keep commits small, commit messages,\\
+      \h{17ex}keep a light repo, pull before making changes}\\[5ex]
+    \item[] \hyperlink{collaboration}{\bf\darkblue Collaboration}
+    \comment{multiple contributors, merge conflicts, plumbing analogy,\\
+      \h{18.3ex}communication, forks, branches, pull requests}\\[5ex]
+    \item[] \hyperlink{folders}{\bf\darkblue Repo organization}
+    \comment{separate folders vs. repos vs. forks vs. branches,\\
+      \h{23.6ex}main git folder}\\[5ex]
+    \item[] \hyperlink{spc}{\bf\darkblue SPC workflows}
+    \comment{github vs. penguin vs. onedrive vs. c-drive vs. virtual machine,\\
+      \h{20ex}open science, reproducible analyses, regional/global
+      collaboration}\\[1ex]
+  \end{itemize}
+\end{frame}
+
+\end{document}