You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/topics/01-setting_up/github_classroom.rst
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,12 @@
1
+
.. _github_classroom:
2
+
1
3
#############################
2
4
Working with GitHub Classroom
3
5
#############################
4
6
5
7
The Python Certificate program uses `GitHub Classroom <https://classroom.github.com/>`_ to manage the submission and review of your coding assignments.
6
8
9
+
7
10
Why GitHub Classroom?
8
11
=====================
9
12
@@ -31,16 +34,12 @@ If you don't have already have a GitHub account or if you would prefer to use cr
31
34
32
35
You will need to have git setup on the computer you will use for developing your code for this course.
33
36
You can find instructions for setting up git (and the rest of your development environment) here:
37
+
34
38
:ref:`installing_python`
35
39
36
40
Once you have all the tools set up, you will need to create a folder (directory) within your development system for keeping your work.
37
41
This is the folder where all your assignment repositories will reside. It will be helpful to keep them all together in one place.
38
42
39
-
.. Open Git Bash (if using Git for Windows) or a terminal (Linux and Mac OS), go to the folder (using the `cd` command) you have created for this class and run::
40
-
41
-
.. git init
42
-
43
-
.. This will setup your folder to house git repositories.
44
43
45
44
Accepting an assignment
46
45
=======================
@@ -63,16 +62,16 @@ Some things to consider:
63
62
64
63
Once your repository has been created, go to its link and clone it on your development system, under the folder you selected for this purpose.
65
64
66
-
Here: `Clong a repo <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository>`_
65
+
Here: `Cloning a repo <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository>`_
67
66
is GitHub's official guide on how to clone a repository.
68
67
69
68
70
69
Before You Start Working on your Assignment
71
70
===========================================
72
71
73
72
Once your repository is setup, it's good to get familiar with your repository view.
74
-
You should see a tab there called "Pull Requests": they indicate code changes that are desired to be pulled into a main repository;
75
-
by default you should see one already there called "Feedback". Go ahead and click on it, and take a look at "Files Changed" tab - as of now it should show "No changes to show". As you start committing your code you will see your changes there.
73
+
You should see a tab there called "Pull Requests": they indicate code changes that are desired to be pulled into a main repository.
74
+
By default you should see one already there called "Feedback". Go ahead and click on it, and take a look at "Files Changed" tab - as of now it should show "No changes to show". As you start committing your code you will see your changes there.
76
75
77
76
78
77
Committing your code
@@ -85,7 +84,7 @@ You are encouraged to make frequent commits, as this will make it easier for you
85
84
Creating a New Commit:
86
85
----------------------
87
86
88
-
Type the following to add all files and subdirectories in the folder to your commit (note the command includes a dot, make sure you include it as well)::
87
+
Type the following to add all files and subdirectories in the folder to your commit (note the command includes a dot, make sure you include it as well: the dot means "the current working directory")::
89
88
90
89
git add .
91
90
@@ -109,6 +108,7 @@ You can push your code immediately after every commit or do it once a day (in wh
109
108
110
109
The first time you push your code to a repository, GitHub will ask you to select the remote repository (i.e., your GitHub repository). Just copy the suggested push command (you will only need to do this once per assignment).
111
110
111
+
git will also askyou for your gitHUb usernameand passwork the firsttime -- it should remember them after that -- until you try on a new machine.
112
112
113
113
Asking Coding Questions
114
114
=======================
@@ -133,7 +133,7 @@ Once your assignment is ready for review, copy the link of your Feedback pull re
133
133
As per UW's requirements, you also need to submit a zip file with your code on EdX or Canvas. Note that only the code included in your pull request will be reviewed.
134
134
135
135
136
-
Resubmitting your assignment
136
+
Resubmitting your Assignment
137
137
============================
138
138
139
139
On occasion, your instructor will provide feedback on elements in your assignment that need to be modified in order to get the full grade for the assignment. In those cases, follow the process outlined in the Asking Coding Questions section above. Let us know that you would like another review for grade adjustment and make sure to tag your instructor.
0 commit comments