Skip to content

add definitions box #409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 15, 2025
Merged

add definitions box #409

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fad04f
add definitions box
jennyhickson Jul 15, 2025
67cb07b
Update source/WorkingPractices/working_practices.rst
jennyhickson Jul 15, 2025
720aa6b
Update source/WorkingPractices/working_practices.rst
jennyhickson Jul 15, 2025
bd8d495
add link to gh glossary!
jennyhickson Jul 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 0 additions & 88 deletions source/WorkingPractices/branches.rst
View file
Open in desktop

This file was deleted.

49 changes: 0 additions & 49 deletions source/WorkingPractices/common_keywords.rst
View file
Open in desktop

This file was deleted.

186 changes: 0 additions & 186 deletions source/WorkingPractices/tickets.rst
View file
Open in desktop

This file was deleted.

14 changes: 12 additions & 2 deletions source/WorkingPractices/working_practices.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,24 @@ the process is very comparable to that of the other repositories too.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth adding a link to the github glossary near this? Something like,

The github glossary https://docs.github.com/en/get-started/learning-about-github/github-glossary_ contains additional definitions to those below

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The mix of markdown and rst didn't work there! I had github glossary as a hyperlink!

.. admonition:: Definitions

``Upstream``: the primary or parent repository, owned by the MetOffice github organisation. Only maintainers have write access to this repository.

``Fork`` or ``Downstream``: a copy of the upstream repository, owned by the developer. This is where development branches are created and worked on.

``Remote``: the version of the upstream or forked repository that is hosted by Github.

``Clone``: a local copy of the upstream or forked repository.

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).

* ``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.
* ``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.

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.
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.

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to remove the hinting of colours? Or am I getting ahead of myself given this is likely not the final flow design?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I figured the flow design was likely to change and we can always include a key in the picture or add a note with it around colours once the final thing was sorted.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah fair enough

The development cycle can be seen below.

.. image:: images/git-dev-strategy.svg
:class: dark-light
Expand Down