commit guidelines
Use conventional commit message format.
Commit Message Prefix
Commit messages must begin with a reference to the work item ID, which is extracted from the Git branch name.
Branch Naming Convention
The branch name follows this format:
<dev initials>_<description (underscored)>_<work item ID>
Example: xy_documentation_updates_123456
Extracting the Work Item ID
From the branch name, extract the numeric suffix — the value after the final underscore (_) — as the work item ID.
Example: For branch xy_configurable_ports_123456, the work item ID is 123456.
Commit Message Format
Start the commit message with the following prefix:
AB#<work item ID> -
Example:
AB#123456 - Updated Docker & GitHub related files with configurable port variables
- This prefix must appear at the very start of the commit message.
- No leading whitespace or characters are allowed.
- Follow the prefix with a brief summary of the change using a past-tense action verb (e.g., “Added”, “Updated”, “Removed”).
Commit Message Formatting
Subject Line (First Line)
- Limit the subject line (first line of the commit message) to 50 characters.
- This provides a concise summary of the commit’s purpose, making it easy to read in Git tools and logs.
- Include a blank line following the subject.
Summary of File Changes
Below the subject line, include a bullet list of all modified files using the following format: