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
+30-17Lines changed: 30 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -34,18 +34,20 @@ You can find instructions for setting up git (and the rest of your development e
34
34
:ref:`installing_python`
35
35
36
36
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
-
This is the folder where all your assignment repositories will reside.
38
-
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::
37
+
This is the folder where all your assignment repositories will reside. It will be helpful to keep them all together in one place.
39
38
40
-
git init
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::
41
40
42
-
This will setup your folder to house git repositories.
41
+
.. git init
42
+
43
+
.. This will setup your folder to house git repositories.
43
44
44
45
Accepting an assignment
45
46
=======================
46
47
47
48
Each assignment page will contain a section named "Accepting your Assignment". Click on the corresponding link, which will take you to GitHub Classroom to accept the corresponding assignment.
48
49
50
+
49
51
Some things to consider:
50
52
------------------------
51
53
@@ -59,34 +61,42 @@ Some things to consider:
59
61
60
62
* The name of the new repository will include your GitHub user name at the end.
61
63
62
-
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 (here (Links to an external site.) is GitHub's official guide on how to clone a repository).
64
+
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
+
66
+
Here: `Clong a repo <https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository>`_
67
+
is GitHub's official guide on how to clone a repository.
63
68
64
69
65
-
Before you start working on your assignment
70
+
Before You Start Working on your Assignment
66
71
===========================================
67
72
68
73
Once your repository is setup, it's good to get familiar with your repository view.
69
74
You should see a tab there called "Pull Requests": they indicate code changes that are desired to be pulled into a main repository;
70
-
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.
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.
76
+
71
77
72
78
Committing your code
73
79
====================
74
80
75
81
A "commit" is snapshot of your code (and any other files included in your project).
76
82
You are encouraged to make frequent commits, as this will make it easier for you to restore your code to an earlier state if things go wrong.
77
83
78
-
To create a new commit:
79
-
-----------------------
80
84
81
-
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):
82
-
``git add``.
85
+
Creating a New Commit:
86
+
----------------------
87
+
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)::
89
+
90
+
git add .
83
91
84
-
Commit your code by typing the following:
85
-
``git commit -m "Commit message"``
92
+
Commit your code by typing the following::
93
+
94
+
git commit -m "Commit message"
86
95
87
96
Note that the commit message should be replaced with something descriptive of what that commit includes ("added new functionality", "fixed floating point error", "ready for review", etc.) that will later help you remember what that particular commit was about.
88
97
89
-
Pushing your code
98
+
99
+
Pushing Your Code
90
100
=================
91
101
92
102
"Pushing" refers to the process of synchronizing the commits you have made on your development system with your GitHub repository.
@@ -99,18 +109,20 @@ You can push your code immediately after every commit or do it once a day (in wh
99
109
100
110
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).
101
111
112
+
102
113
Asking Coding Questions
103
114
=======================
104
115
105
116
While working on your code, you might run into a situation in which you would like one of the instructors to look at it and provide some feedback before actually reviewing and grading it.
106
-
In order to do that, go to "Feedback" pull request and write a comment about your question or issue. You should make sure to tag your instructor in your comment, to assure that they ar noticfied of your comment. This is done by writing `@the_instrudtors_github_handle`, e.g. `@natasha-aleksandrova`.
117
+
In order to do that, go to "Feedback" pull request and write a comment about your question or issue. You should make sure to tag your instructor in your comment, to assure that they are notified of your comment. This is done by writing `@the_instructors_github_handle`, e.g. `@natasha-aleksandrova`.
107
118
108
119
For example::
109
120
110
121
@natasha-aleksandrova: I need some help on line 20
111
122
112
123
When you submit a comment with a tag, the instructor will be notified by GitHub and will be able to review your question.
113
124
125
+
114
126
Submitting your assignment
115
127
==========================
116
128
@@ -120,8 +132,9 @@ Once your assignment is ready for review, copy the link of your Feedback pull re
120
132
121
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.
122
134
123
-
9. Resubmitting your assignment
124
-
===============================
135
+
136
+
Resubmitting your assignment
137
+
============================
125
138
126
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