Skip to content

Commit 6aa0f6b

Browse files
committed
lots of new text in the gitHub classroom page!
1 parent d18d645 commit 6aa0f6b

File tree

12 files changed

+257
-52
lines changed

12 files changed

+257
-52
lines changed

source/modules/Py2vsPy3.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
Python 2 versus Python 3
55
########################
66

7+
now that Python version 2 has officially reached end of life, most recent information is in/about Python 3.
78

8-
Much of the example code you'll find online is Python2, rather than Python3
9+
But you will still find a lot of older example code online in Python2, rather than Python3
910

1011
For the most part, they are the same -- so you can use those examples to learn from.
1112

@@ -98,4 +99,3 @@ Most of the other differences are essentially implementation details, like getti
9899

99100
There are also a few syntax differences with more advanced topics: Exceptions, ``super()``, etc.
100101

101-
We'll talk about all that when we cover those topics as well.

source/topics/01-setting_up/feature_branching.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
Feature Branching
33
*****************
44

5+
.. note:: Feature branching is an important topic, but not one you need to know about right off -- if you are brand new to git -- feel free to ignore this, with gitHub classroom, it should handle it for you.
6+
7+
58
Why use Feature Branches?
69
=========================
710

source/topics/01-setting_up/git.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ Git is a very powerful and useful tool. We only use a few of its features for th
1010
intro_to_git
1111
github_classroom
1212
git_overview
13-
feature_branching
1413
git_hints
14+
feature_branching

source/topics/01-setting_up/git_hints.rst

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,10 @@ git is a very complex system, and can be used in many ways. Because of this, it
88

99
Every group using git has to establish a standard "work flow". If you google "git workflow" you find a LOT of discussion, and they are not all the same. And depending on the workflow you are using, the problems you'll have and the solutions to them will be different.
1010

11-
We are using a very simplified workflow for this class, and this page seeks to provide solutions to problems that you might encounter specifically with this workflow.
11+
We are using a very simplified workflow with gitHub classroom for this class, and this page seeks to provide solutions to problems that you might encounter specifically with this workflow.
12+
13+
.. note:: This is a page for reference. It is a bit outdated, and should not be required right off. But do remember that it's here if you get tangled up in git as we move along.
14+
1215

1316
"origin" and "upstream"
1417
=======================
@@ -33,27 +36,18 @@ After cloning a repository (from gitHub, for instance) on your machine, is will
3336
3437
so I have one remote repository, on gitHub. It is listed twice, as I am both fetching from (pulling) and pushing to the same repository. "origin" is created when you do a clone, and it is the one that is pushed to and pulled from by default. git is so flexible that you could set it up to push and pull be default to two different repos, but I've never seen that done.
3538

36-
In case of the PythonCertclass, we need *another* remote repository:
37-
38-
There is the central class repository, which only the instructors have permissions to change. But you want to be able to get updated materials from that repository as well. Since this repo is the one your personal repo was "forked" from, the convention is to call it the "upstream" repository. You should have set that up with a command like this:
39-
40-
.. code-block:: bash
39+
There is often use for having more than one remote repository, to keep various workflows in sync. But with gitHub classroom, you will have one: the "origin" remote that was created when you cloned your gitHub repo.
4140

42-
$ git remote add upstream https://github.com/UWPCE-PythonCert-ClassRepos/Sp2018-Accelerated.git
41+
Adding a remote
42+
---------------
4343

44-
And it should look something like this when you check your remotes:
44+
If you do need to add a remote, you it's pretty easy:
4545

4646
.. code-block:: bash
4747
48-
$ git remote -v
49-
origin https://github.com/PythonCHB/Sp2018-Accelerated.git (fetch)
50-
origin https://github.com/PythonCHB/Sp2018-Accelerated.git (push)
51-
upstream https://github.com/UWPCE-PythonCert-ClassRepos/Sp2018-Accelerated.git (fetch)
52-
upstream https://github.com/UWPCE-PythonCert-ClassRepos/Sp2018-Accelerated.git (push)
53-
54-
So I now have two more remotes, one for pushing and one for pulling (fetching).
48+
git remote add name_of_remote https://the_long_url_to_the_remote_repo.git
5549
56-
Do this now on your own machine, and make sure that "origin" points to your repo on gitHub, and "upstream" is pointed to the one in the "UWPCE-PythonCert-ClassRepos" gitHub organization.
50+
"upstream" is a common name for antoher remote you need to talk to.
5751

5852
Changing a remote
5953
-----------------
@@ -66,9 +60,8 @@ If your remotes are not set up right, you can reset them, but removing one:
6660
6761
and then adding it back correctly:
6862

69-
$ git remote add upstream https://github.com/UWPCE-PythonCert-ClassRepos/Sp2018-Accelerated.git
63+
$ git remote add upstream https://the_long_url_to_the_remote_repo.git
7064

71-
**make sure to adjust that command for your particular class!**
7265

7366
Working with "upstream"
7467
-----------------------

0 commit comments

Comments
 (0)