Getting started with Git-based collaboration in [#git]

The following Git guidance is intended to help new LinkORB software engineers and technical writers quickly and easily integrate with the team.

First time contributors

• Learn about our Git standards and processes

Making changes

• Create and use a new branch when making changes to your fork of a repository. Do not directly modify the default (e.g. main or master) branch.

Naming branches

• Use short (50 characters or less), descriptive branch names that terminate with the card number of the associated Team HQ work item. E.g. fix-broken-function-6233. This allows you to lookup and add the card number to the commit message’s header without leaving the commit message editor.

Writing conventional commit messages

• Conventional commit standards
• Configure LinkORB’s commit message template

Creating and reviewing pull requests

• Creating and reviewing pull requests