Git & Delivery More detail B · Official guidance Platform: General

Git Submodule

A Git submodule lets one repository point to one exact commit in another Git repository. The parent repository also stores how to find it.

See how it works
You might call it Git Submodule

See how it works

Original worked exampleGit Submodule

Another example

An app repository uses firmware kept in its own repository. The parent project records one reviewed firmware commit and setup steps load it. Pulling the submodule's newest branch does not update the parent pointer by itself.

Main parts

  1. 01superproject gitlink
  2. 02submodule URL
  3. 03pinned commit

Use it when

Use this term when one repository must lock another independently managed repository to an exact commit.

Do not use it when

Avoid submodules when a released package or copied snapshot gives simpler ownership and updates.

Name used in code

gitlink + .gitmodules + nested repository

Before you ship

Before publishing, check the exact repository, branch, target, and diff. Keep unpublished work. Pass review and CI checks. Record conflict and data-loss risks, release order, traceability, recovery, and rollback.

Request you can copy

Outcome: Use Git Submodule to release or recover the change safely, with a clear record. User context: An app repository uses firmware kept in its own repository. The parent project records one reviewed firmware commit and setup steps load it. Pulling the submodule's newest branch does not update the parent pointer by itself. Delivery concept or operation: Git Submodule. Why it fits: Use this term when one repository must lock another independently managed repository to an exact commit. Do not use it when: Avoid submodules when a released package or copied snapshot gives simpler ownership and updates. Delivery requirements: Name the code repository and target. List preconditions, changes, review and CI checks, conflict and data-loss risks, release order, and the rollback or recovery command. Repository safeguards: Keep unpublished work and a clear history. Do not run destructive steps without an explicit backup. Check the exact code diff and remote target before publishing. Acceptance criteria: Review the intended diff and pass all required checks. Keep the target version traceable. Practice failure recovery and keep published history clear. Evidence and limits (evidence boundary): It is official for that source. Other platforms or teams may use the term in another way. Unknowns to confirm: Repository, branch, team activity, release environment, approval owner, protected checks, and rollback target.

Check this request

Review the current use of Git Submodule. Definition: A Git submodule lets one repository point to one exact commit in another Git repository. The parent repository also stores how to find it. Release checks: Before publishing, check the exact repository, branch, target, and diff. Keep unpublished work. Pass review and CI checks. Record conflict and data-loss risks, release order, traceability, recovery, and rollback. Before changing code, report the evidence you found, gaps, severity, and the smallest safe fix.

B
How official is this term?

Official guidance

The named platform, framework, project, or expert group has an official guide for this term.

It is official for that source. Other platforms or teams may use the term in another way.

Scope
Git
Document status
stable
Checked on
2026-07-30

Evidence sources & scope

Authority source + Term reference · Git · stable git-submodule Scope: Git submodule metadata and operations Role here: Direct term reference Source covers: canonical name, definition, platform API, implementation, usage guidance

Copy it yourself

The browser could not copy this. Select the request below and copy it yourself.