Uploaded image for project: 'Migration Toolkit for Virtualization'
  1. Migration Toolkit for Virtualization
  2. MTV-3161

[Konflux] Implement standard for commit messages

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • Konflux
    • None
    • MTV Sprint 3, MTV Sprint 4

      Now we do not have any standard for commit messages.

      For automation to be as successful as possible, we should have some kind of commit message template where we specify, what bugs/features are included in the commits.

      Implement a GH action to validate the commit message and block the merge if the commit message does not pass the check (watch out for and exclude non user PRs e.g. konflux nudges, MintMaker PRs...).

      This could also be done with Resolves: MTV-123 MTV-234 line in the commit description instead of the commit message similarly as it's done in RHEL. This approach may even be better in some cases (e.g. not all fixed issues fit inside the commit msg)

      Also think of a way to exclude a commit from this check, example: Resolves: None

      Example messages:

       

      When implemented, please announce the change so that all developers are aware of this change.

              kbempah Kyl Bempah
              rh-ee-solenoci Stefan Olenocin
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: