diff --git a/instructions/adding-labels-cropped.png b/instructions/adding-labels-cropped.png new file mode 100644 index 0000000..dec0e1d Binary files /dev/null and b/instructions/adding-labels-cropped.png differ diff --git a/instructions/adding-labels.png b/instructions/adding-labels.png new file mode 100644 index 0000000..bcea2a2 Binary files /dev/null and b/instructions/adding-labels.png differ diff --git a/instructions/assign-to-developer-cropped.png b/instructions/assign-to-developer-cropped.png new file mode 100644 index 0000000..92360d1 Binary files /dev/null and b/instructions/assign-to-developer-cropped.png differ diff --git a/instructions/assign-to-developer.png b/instructions/assign-to-developer.png new file mode 100644 index 0000000..d84905c Binary files /dev/null and b/instructions/assign-to-developer.png differ diff --git a/instructions/clickin-new-issue-cropped.png b/instructions/clickin-new-issue-cropped.png new file mode 100644 index 0000000..43d956c Binary files /dev/null and b/instructions/clickin-new-issue-cropped.png differ diff --git a/instructions/clickin-new-issue.png b/instructions/clickin-new-issue.png new file mode 100644 index 0000000..557fde4 Binary files /dev/null and b/instructions/clickin-new-issue.png differ diff --git a/instructions/finding-issues-page-cropped.png b/instructions/finding-issues-page-cropped.png new file mode 100644 index 0000000..822c197 Binary files /dev/null and b/instructions/finding-issues-page-cropped.png differ diff --git a/instructions/finding-issues-page.png b/instructions/finding-issues-page.png new file mode 100644 index 0000000..c29f1fa Binary files /dev/null and b/instructions/finding-issues-page.png differ diff --git a/instructions/instr.pdf b/instructions/instr.pdf index c680e47..c55a3f6 100644 Binary files a/instructions/instr.pdf and b/instructions/instr.pdf differ diff --git a/instructions/instr.tex b/instructions/instr.tex index 194b4c0..5e1603f 100644 --- a/instructions/instr.tex +++ b/instructions/instr.tex @@ -3,12 +3,12 @@ \usepackage{graphicx} \oddsidemargin0cm -\topmargin-2cm -\textwidth16.5cm -\textheight23.5cm +\topmargin-3cm +\textwidth16.0cm +\textheight24.5cm \newcommand{\step}[2] {\vspace{.25in} \hrule\vspace{0.5em} - \noindent{\bf #1: #2} \vspace{0.5em} + \noindent{\bf Step #1: #2} \vspace{0.5em} \hrule \vspace{.10in}} \begin{document} @@ -36,17 +36,109 @@ This tutorial is for GitHub users who know how to create and use repositories, but are unfamiliar with GitHub's issue tracking features. \step{1}{Open your repository's Issues page} +{\bf In this step, you will access the Issues page for your repository.} -\step{1}{Create an issue} -Create the issue. Done. +\begin{enumerate} +\item Open your GitHub repository in your web browser. +\item Click ``Issues'' (Fig \ref{fig:issues_button}) +\item You should now see the ``Issues'' page, which you will use in Step 2. +\end{enumerate} -\step{2}{Assign labels to an issue} -An issue is just a monoid object in a monoidal category of endofunctors. +\begin{figure}[h] + \includegraphics[width=\linewidth]{finding-issues-page-cropped.png} + \caption{Opening the Issues page} + \label{fig:issues_button} +\end{figure} -\step{3}{Assign an issue to a developer} -What's the problem? +\pagebreak -\step{4}{Marking an issue as resolved} -Making edit to resolve the issue that will be used as an example here. +\step{2}{Create an issue} +{\bf In this step, you will create a new issue associated with your repository and +fill in necessary information} + +\begin{enumerate} +\item Click the ``New Issue'' button (Fig \ref{fig:new_issue}) +\item Enter in a title for the issue (1, Fig \ref{fig:issue_info}) +\item Enter in a description for the issue (2, Fig \ref{fig:issue_info}) +\item Click ``Submit new issue'' (3, Fig \ref{fig:issue_info}) +\item Step 3 will go over how to add a label to your newly-created issue. +\end{enumerate} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{clickin-new-issue-cropped.png} + \caption{Creating a new issue} + \label{fig:new_issue} +\end{figure} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{new-issue-info-cropped.png} + \caption{Entering issue information} + \label{fig:issue_info} +\end{figure} + +\pagebreak + +\step{3}{Assign labels to an issue} +{\bf In this step, you will label your issue, indicating what type of issue it is.} + +\begin{enumerate} +\item Click the ``Labels'' button (1, Fig \ref{fig:labels}) +\item Click each label that applies to your issue (2, Fig \ref{fig:labels}) +\item Click the X button (3, Fig \ref{fig:labels}) +\item In step 4, you will assign this issue to a developer. +\end{enumerate} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{adding-labels-cropped.png} + \caption{Adding labels to an issue} + \label{fig:labels} +\end{figure} + +\pagebreak + +\step{4}{Assign an issue to a developer} +{\bf In this step, you will assign this issue to a developer who will fix the issue.} + +\begin{enumerate} +\item Click the ``Assignee'' button (1, Fig \ref{fig:assign}) +\item Click the name of the developer who will fix the issue (2, Fig \ref{fig:assign}) +\item At this point, the issue has been assigned to the deveoper. + Once the developer has fixed the issue, proceed to step 5 to mark the issue as resolved. +\end{enumerate} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{assign-to-developer-cropped.png} + \caption{Assigning an issue to a developer} + \label{fig:assign} +\end{figure} + +\pagebreak + +\step{5}{Marking an issue as resolved} +{\bf In this step, you will mark the issue as resolved, + indicating that the developer assigned to the issue has fixed it.} + +\begin{enumerate} +\item On the issue web page, you can see the issue number. + In our example, our issue is \#3 (Fig \ref{fig:issue_number}). +\item Make a commit including the changes that fix the issue. + In the commit message, include the text ``Resolves \#N'', replacing ``N'' with your issue number. + In the example issue, the commit message would be ``Resolves \#3''. +\item GitHub detects this commit and marks the issue as closed (Fig \ref{fig:resolved}). + At this point, you have successfully created a GitHub issue, fixed the problem in the repository, + and marked the issue as resolved. +\end{enumerate} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{issue-number-cropped.png} + \caption{Finding the issue number} + \label{fig:issue_number} +\end{figure} + +\begin{figure}[h] + \includegraphics[width=\textwidth]{issue-resolved-cropped.png} + \caption{The issue has been resolved} + \label{fig:resolved} +\end{figure} \end{document} diff --git a/instructions/issue-has-been-assigned-cropped.png b/instructions/issue-has-been-assigned-cropped.png new file mode 100644 index 0000000..9c5a211 Binary files /dev/null and b/instructions/issue-has-been-assigned-cropped.png differ diff --git a/instructions/issue-has-been-assigned.png b/instructions/issue-has-been-assigned.png new file mode 100644 index 0000000..5966fd1 Binary files /dev/null and b/instructions/issue-has-been-assigned.png differ diff --git a/instructions/issue-number-cropped.png b/instructions/issue-number-cropped.png new file mode 100644 index 0000000..b934c8d Binary files /dev/null and b/instructions/issue-number-cropped.png differ diff --git a/instructions/issue-resolved-cropped.png b/instructions/issue-resolved-cropped.png new file mode 100644 index 0000000..07fc407 Binary files /dev/null and b/instructions/issue-resolved-cropped.png differ diff --git a/instructions/issue-resolved.png b/instructions/issue-resolved.png new file mode 100644 index 0000000..6d9b6cb Binary files /dev/null and b/instructions/issue-resolved.png differ diff --git a/instructions/label-has-been-added-cropped.png b/instructions/label-has-been-added-cropped.png new file mode 100644 index 0000000..588503b Binary files /dev/null and b/instructions/label-has-been-added-cropped.png differ diff --git a/instructions/label-has-been-added.png b/instructions/label-has-been-added.png new file mode 100644 index 0000000..a4fab5b Binary files /dev/null and b/instructions/label-has-been-added.png differ diff --git a/instructions/new-issue-info-cropped.png b/instructions/new-issue-info-cropped.png new file mode 100644 index 0000000..3611c0c Binary files /dev/null and b/instructions/new-issue-info-cropped.png differ diff --git a/instructions/new-issue-info.png b/instructions/new-issue-info.png new file mode 100644 index 0000000..034a2e6 Binary files /dev/null and b/instructions/new-issue-info.png differ