17.3 Commit Conventions

Go To Top

Return to Git and Review Workflow

Commits should describe intentional changes to the Phase 0 Baseline. A commit should group related changes so that reviewers can understand the purpose, scope, and impact of the change.

A commit message should identify the kind of change and its subject. The team may use a simple convention such as:

• docs: update tool baseline checklist rules
• script: add prerequisite validation
• idl: add node status type
• node: add validation node lifecycle handling
• config: add baseline DDS QoS profile
• test: add control-plane status validation
• container: add observer container definition

A commit should not mix unrelated changes unless the team intentionally bundles them for a reviewed Baseline update. For example, a change to an IDL file may properly include regenerated type Artifacts and affected tests. A change to spelling in documentation should not also change runtime behavior.

Developers should not commit local virtual environments, temporary logs, build outputs, local overrides, editor caches, machine-specific files, or unmanaged generated Artifacts. The .gitignore file should support this rule, but developers remain responsible for reviewing staged changes before committing.

---