Skip to content

Instantly share code, notes, and snippets.

@carlosbustillordguez

carlosbustillordguez/PR_Title_Conventional_Commit.md

Last active June 14, 2024 15:04
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save carlosbustillordguez/c7c45a1cfbb50c30a488ceebda6ef18f to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save carlosbustillordguez/c7c45a1cfbb50c30a488ceebda6ef18f to your computer and use it in GitHub Desktop.
Download ZIP
Pull Request title for Conventional Commit specification
Raw
PR_Title_Conventional_Commit.md

The PR title must follow the Conventional Commit specification. For this, the allowed structure is:

feat(ui): add buttom component
^    ^    ^
|    |    |__ Subject
|    |_______ Scope
|____________ Type
  • The allowed type must match with the accepted commit types defined in the Conventional Commit specification. For updated component versions in a Helm chart or bumped versions, we must use the feat type.
  • The scope is optional, and would be the Jira issue/ticket in which you are working. Uses no-ref when there’s no reference to a ticket; although it’s not recommended to do code changes with non-tracked changes.
  • The subject must match the following regex ^(?![A-Z]).+$ (ensures the subject doesn't start with an uppercase character).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment