Skip to content

Long description of the commit

Sets up an optional field to add a detailed description to the commit, allowing you to supplement the main summary with more context about the change made.

This field may be used to explain motivations, technical decisions or relevant additional information that does not fit in the short description.

yaml
longDescription:
  enabled: true
  description: "Additional details"
  required: false
  minLength: 20
  maxLength: 100
FieldRequiredTypeDefaultDescription
enabledNoBooleanfalseEnables or disables the long description field during commit creation.
descriptionNoString-Text displayed as auxiliary instruction in the interactive assistant (wizard), guiding the completion of the long description.
requiredNoBooleanfalseSets whether long description completion is mandatory when the field is enabled.
minLengthNoInt0Minimum number of characters allowed for long description.
maxLengthNoInt100Maximum number of characters allowed for long description.

Released under the Apache License.