Skip to content

Commit e9b9835

Browse files
Update fork and assistance bot advice (MetOffice#570)
1 parent ad77d3e commit e9b9835

1 file changed

Lines changed: 12 additions & 4 deletions

File tree

source/WorkingPractices/forking.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,13 +89,21 @@ Actions/General. There select the option to ``Disable actions`` and save.
8989
Optional - Adding the MetOffice Mirror Bot
9090
------------------------------------------
9191

92+
.. important::
93+
94+
While this step is optional, the suggested approach for extracting code for
95+
scientific suites uses these Git Mirrors. If you are likely to use branches
96+
in these suites, then this step is recommended.
97+
9298
The ``mo-gitassist-bot`` is a user which can be granted read access to a
9399
repository, allowing it to mirror the repository to a central location on
94100
MetOffice platforms. This repository can then be cloned using the local mirror,
95-
avoiding the need to authenticate with GitHub. This may be useful, eg. for
96-
shared accounts which do not have a GitHub account themselves. The mirrors are
97-
read only - committing and pushing back to the remote repository will require a
98-
GitHub account.
101+
avoiding the need to authenticate with GitHub.
102+
103+
This is the recommended approach for extracting code for scientific suites and
104+
may be useful for shared accounts which do not have a GitHub account themselves.
105+
The mirrors are read only - committing and pushing back to the remote repository
106+
will require a GitHub account.
99107

100108
All simulation systems repositories have granted access to this bot, allowing
101109
them to be cloned from the mirrors by running,

0 commit comments

Comments
 (0)