.ai/git.md
Before creating any branch or commit, or adding changelog entries, validate against all rules in this file.
Allowed characters: lowercase letters, numbers, hyphens (-), underscores (_). No spaces. No uppercase.
Use these default patterns unless a different name is specified:
feature/<description> for new featuresfix/<description> for bug fixesdocs/<description> for documentation-only changesdocs-<description> for documentation-only changes (alternative)refactor/<description> for code refactoring<issue-number>-<description> for issue-linked changes<issue-number>-<description>-docs for issue-linked documentation changesDo not use 40-character hexadecimal strings (these conflict with Git commit hashes).
Documentation branches (docs/ or docs- prefix, or -docs suffix) trigger faster CI pipelines. Use them for documentation-only changes.
Allowed prefixes: [API], danger:, and similar category prefixes are permitted before the subject.
Required when the commit changes 30 or more lines across 3 or more files.
If a body is included:
Use full URLs. Do not use short references.
Resolves https://gitlab.com/gitlab-org/gitlab/-/issues/123456Resolves #123456Add Changelog: <type> as the last line of the commit message body.
added, fixed, changed, deprecated, removed, security, performance, other
For EE-only changes, add EE: true on a separate line after the changelog entry.
added, fixed, changed, deprecated, removed, security, performance, other
| Scenario | Changelog type |
|---|---|
| Removing default-off flag, keeping the new feature | added / changed / fixed (describe the feature) |
| Removing default-off flag, removing the new feature (rollback) | other |
| Removing default-on flag, keeping the new feature (cleanup) | other |
| Removing default-on flag, reverting to old behavior | removed / changed |