Merge topic 'github-cheatsheet'

ffdca09 DOC: Update ITK Git Reference for GitHub

Author: thewtex

Documentation/GitCheatSheet.pdf

@@ -61,10 +61,9 @@ \subsection*{One-time Global Setup}
 \subsection*{Create and Configure Your Repository}
 \begin{category}{Clone Repository}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git clone --recursive git://itk.org/ITK.git\\ cd ITK}
+  \texttt{git clone https://github.com/InsightSoftwareConsortium/ITK\\ cd ITK}
 }
 \parbox[t]{0.38\cvmain}{%
-Clones the source tree.
 }
 \end{category}
 \begin{category}{Configure}
@@ -79,15 +78,15 @@ \subsection*{Create and Configure Your Repository}
 \subsection*{Topic Branch Lifecycle}
 \begin{category}{Update}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git status\\ git checkout master\\ git pull --rebase}
+  \texttt{git status\\ git checkout master\\ git pull --rebase upstream master}
 }
 \parbox[t]{0.38\cvmain}{%
 Review local modifications, delete, stash or commit them.
 }
 \end{category}
 \begin{category}{New Topic Branch}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git checkout -b my-topic origin/master}
+  \texttt{git checkout -b my-topic upstream/master}
 }
 \parbox[t]{0.38\cvmain}{%
 Create branch off master.
@@ -114,7 +113,7 @@ \subsection*{Topic Branch Lifecycle}
 \begin{category}{Amend Commit}
 \parbox[t]{0.6\cvmain}{%
   \texttt{vim MyExistingFile.cxx\\
-  git addd MyExistingFile.cxx\\
+  git add MyExistingFile.cxx\\
   git commit --amend}
 }
 \parbox[t]{0.38\cvmain}{%
@@ -123,48 +122,56 @@ \subsection*{Topic Branch Lifecycle}
 Amend previous commit locally.
 }
 \end{category}
-\begin{category}{Submit for Review}
+\begin{category}{Add Testing Data}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git prepush\\ git gerrit-push}
+  \texttt{git data-upload DataFile.png\\
+  \# Add DATA\{DataFile.png\} to CMakeLists.txt\\
+  git add -- DataFile.png.sha512 CMakeLists.txt\\
+  git commit --amend}
 }
 \parbox[t]{0.38\cvmain}{%
-Check what will be pushed to Gerrit.\\
-Push the topic to Gerrit for review.
+Upload a testing data input or baseline image to
+  \href{https://data.kitware.com}{data.kitware.com}.\\
+  Reference the content link in the CMake configuration.\\
+  Add the content link and updated CMake configuration.
 }
 \end{category}
-\begin{category}{Respond to Review}
+\begin{category}{Submit for Review}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git rebase -i HEAD~3\\ git prepush\\ git gerrit-push}
+  \texttt{git prepush\\ git review-push}
 }
 \parbox[t]{0.38\cvmain}{%
-Modify local commits (3 back here).\\
-Check what will be pushed to Gerrit.\\
-Push the updated topic to Gerrit.
+Check what will be pushed to GitHub.\\
+Push the topic to GitHub for review.
+Enter the URL returned in your browser, and review and open the pull request.
 }
 \end{category}
-\begin{category}{Merge Topic}
+\begin{category}{Respond to Review}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git stage-push\\ git stage-merge}
+  % sim -> Improved tilde
+  \texttt{git rebase -i HEAD{\raise.17ex\hbox{$\scriptstyle\sim$}}3\\ git prepush\\ git review-push --force}
 }
 \parbox[t]{0.38\cvmain}{%
-Stage the topic branch.\\
-Merge the topic branch to master.
+Modify local commits (3 back here).\\
+Check what will be pushed to Gerrit.\\
+Push the updated topic to Gerrit.
 }
 \end{category}
 \begin{category}{Delete Topic}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git fetch\\ git branch -d my-topic}
+  \texttt{git fetch upstream\\ git branch -d my-topic}
 }
 \parbox[t]{0.38\cvmain}{%
 Fetch the latest changes from origin.\\
 Delete topic, fails if not merged.
 }
 \end{category}
 
+\newpage
 \subsection*{Review}
 \begin{category}{Push for Review}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{git-review-push}
+  \texttt{git review-push}
 }
 \parbox[t]{0.38\cvmain}{%
 Push the current topic branch for review.
@@ -190,13 +197,13 @@ \subsection*{Review}
 \subsection*{General Guidelines}
 \begin{category}{Commit Message}
 \parbox[t]{0.6\cvmain}{%
-  \texttt{<short-description>\\ \\ <long description>\\ refs \#1234}
+  \texttt{<short-description>\\ \\ <long description>\\ Issue \#1234}
 }
 \parbox[t]{0.38\cvmain}{%
-Should be less than 60 characters.\\
+Should be less than 78 characters.\\
 Blank line after short description.\\
 Could be several paragraphs.\\
-Mantis issue number if applicable.
+GitHub issue number, if applicable.
 }
 \end{category}
 \begin{category}{Topic Naming}
@@ -213,4 +220,4 @@ \subsection*{General Guidelines}
 For more information, see \href{https://git-scm.com/}{git-scm.com}.
 \end{center}
 
-\end{document}
+\end{document}