Skip to content

Commit e75d415

Browse files
review comments
1 parent 569bd3c commit e75d415

2 files changed

Lines changed: 40 additions & 12 deletions

File tree

source/WorkingPractices/forking.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -99,18 +99,30 @@ contains the newly released code.
9999

100100
.. tab-item:: gh cli
101101

102-
Run the following command, substituting for the downstream fork owner
103-
and repo name. Without the ``-b`` option, only the default branch will
104-
be synced. You may want to sync both ``stable`` and ``main``,
105-
particularly at a release.
106-
107102
.. code-block:: shell
108103
109-
gh repo sync <OWNER>/<REPO> -b <BRANCH>
104+
gh repo sync [<owner>/<repo>] [-b <branch>]
110105
111-
The synced branch will still only exist in the remote repository. If
112-
you require them in a local clone make sure to ``fetch`` or ``pull``
113-
the repository.
106+
* The command syncs changes from a remote repository to your fork or
107+
local copy.
108+
* Both ``<owner>/<repo>`` and ``-b <branch>`` are optional.
109+
* If ``-b <branch>`` isn't specified, it will sync the default branch
110+
(main),
111+
* There is no built-in ``gh repo sync`` option for all branches,
112+
therefore the user needs to specify a branch name when not syncing the
113+
not the default branch.
114+
* If you run this without ``<owner>/<repo>``, it will sync changes from
115+
the remote origin to your local clone.
116+
117+
* Doing this will not update your remote fork, this will also require
118+
a ``git push`` command.
119+
120+
* By providing your username and fork name to ``<owner>/<repo>``, it
121+
will sync changes from the upstream parent repository into your remote
122+
fork.
123+
124+
* Doing this will not update your local clone, this will also require
125+
a ``git pull`` command.
114126

115127
.. tab-item:: git commands
116128

@@ -135,6 +147,6 @@ contains the newly released code.
135147
.. tip::
136148

137149
Note that the options above will result in the synced branch being available
138-
in different locations. Using the web browser or ``gh`` will not update your
150+
in different locations. Using the web browser will not update your
139151
local clone while using ``git`` commands will not update the remote
140-
repository without pushing.
152+
repository without pushing. ``gh`` can be used to update either.

source/WorkingPractices/gh_authorisation.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ Initial Setup
1717
All users looking to interact with the simulation system repositories, will need
1818
to create a `github account
1919
<https://docs.github.com/en/get-started/start-your-journey/creating-an-account-on-github>`_.
20+
Please visit `<https://github.com/signup>`_ to create an account.
2021

2122
`Multi Factor Authentication
2223
<https://docs.github.com/en/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication>`_
2324
should also be enabled. This will be a requirement to accesses certain
24-
repositories, but is encouraged for all users.
25+
repositories, but is encouraged for all users. When signed in, account security
26+
settings can be found at `<https://github.com/settings/security>`_.
2527

2628
.. admonition:: todo
2729

@@ -43,6 +45,20 @@ and `commit email address
4345
git config --global user.name "User Name"
4446
git config --global user.email "User Email"
4547
48+
# Verify
49+
git config --global user.name
50+
git config --global user.email
51+
52+
.. tip::
53+
54+
Github has functionality that can keep your email address private.
55+
56+
* Navigate to `<https://github.com/settings/emails>`_
57+
* Enable the **Keep my email addresses private** setting. This should
58+
generate a unique noreply email address for you, which will look like
59+
``ID+username@users.noreply.github.com``.
60+
* Use this email address instead in the command above.
61+
4662
SSH Key Setup
4763
-------------
4864

0 commit comments

Comments
 (0)