Skip to content

tools: Add a commit msg checker script

Mohamed Omar Asaker requested to merge ci/add-commit-msg-checker into main

Script will perform some checks on the commit message to make sure it follows the best practices and the agreed convention.

  • Structure check: Prefered title structure `[/name][/test]: optional component name optional [test] if change is related to testing

  • Prefix check: All commits title should have a prefix showing which part it adds/modify to in the code base. There are some prefered prefixes:

    • arch: Changes contribute to architecture
    • ci: Changes contribute to Continuous Integration
    • doc: Changes contribute to documentations
    • fwk: Changes contribute to the framework
    • mod: Changes contribute to a module
    • prod: Changes contribute to a product
    • tools: Changes contribute to helping tools/scripts provided

Note: when changes affect multiple area its better to break commits into smaller but its up to the developer to choose the dominant area.

  • Typo checks
  • Character limits per line
  • Commit message structure

Signed-off-by: Mohamed Omar Asaker mohamed.omarasaker@arm.com

Merge request reports