Skip to content

Commit 0fad04f

Browse files
committed
add definitions box
1 parent 45db38d commit 0fad04f

File tree

4 files changed

+12
-325
lines changed

4 files changed

+12
-325
lines changed

source/WorkingPractices/branches.rst

Lines changed: 0 additions & 88 deletions
This file was deleted.

source/WorkingPractices/common_keywords.rst

Lines changed: 0 additions & 49 deletions
This file was deleted.

source/WorkingPractices/tickets.rst

Lines changed: 0 additions & 186 deletions
This file was deleted.

source/WorkingPractices/working_practices.rst

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,24 @@ the process is very comparable to that of the other repositories too.
5959

6060
To get started with the ``gh`` cli, see the `gh quickstart guide <https://docs.github.com/en/github-cli/github-cli/quickstart>`_
6161

62+
.. admonition:: Definitions
63+
64+
``Upstream``: the primary or parent repository, owned by the MetOffice github organisation. Only maintainers have write access to this repository.
65+
66+
``Fork`` or ``Downstream``: a copy of the upstream repository, owned by the developer. This is where development branches are created and worked on.
67+
68+
``Remote``: the version of the upstream or forked repository that is hosted by Github.
69+
70+
``Clone``: a local copy of the upstream or forked repository.
71+
6272
Simulation Systems github repositories are setup with at least 2 protected branches, ``stable`` and ``main`` (with the potential for additional version branches to be added).
6373

6474
* ``stable`` - This branch is the default github branch and generally remains unchanged throughout a release cycle. It is the stable point from which new branches should be cut. Only new releases and small hotfixes to a release will be merged back into this branch.
6575
* ``main`` - This branch is where new development pull requests will be merged. It will never be behind the ``stable`` branch, but will regularly be ahead. All pull requests should be set to target this branch (more on this later) and a CI check will fail if it isn't.
6676

67-
All general development for Simulation Systems Github repos will take place on forks of that repository. It is the responsibility of the developer to maintain their own fork. See :ref:`forking` for advice on forking.
77+
All general development for Simulation Systems Github repositories will take place on forks of that repository. It is the responsibility of the developer to maintain their own fork. See :ref:`forking` for advice on forking.
6878

69-
The development cycle can be seen below. ``Upstream`` (blue) refers to parent repository, owned by the MetOffice github organisation. ``Downstream`` (grey) refers to the forked repository, owned by the developer.
79+
The development cycle can be seen below.
7080

7181
.. image:: images/git-dev-strategy.svg
7282
:class: dark-light

0 commit comments

Comments
 (0)