9 CommitMessageBestPractices
Steve Clement edited this page 2018-10-30 10:14:01 +09:00

Commit messages best practices

The overall format is the following for the first line.

ACTION: [namespace] COMMIT_MSG

It's mainly following gitchangelog default configuration to ensure generation of readable ChangeLog (which are published on http://www.misp-project.org/Changelog.txt)

and followed by a space then a complete description of the changes (as optional).

Action

  • chg is for refactor, small improvement, cosmetic changes...
  • fix is for bug fixes
  • new is for new features, big improvement

Namespaces

name_of_namespace usage
[misp-galaxy] Changes or creations of MISP galaxies
[misp-taxonomy] Changes or creations of MISP taxonomies
[misp-noticelist] Changes or creations of MISP noticelists
[misp-warninglists] Changes or creations of MISP warninglists
[misp-object] Changes or creations of MISP objects
[stix 1 import] Changes or creations to the Stix 1 import functionalities.
[stix 2 import] Changes or creations to the Stix 2 import functionalities.
[stix 1 export] Changes or creations to the Stix 1 export functionalities.
[stix 2 export] Changes or creations to the Stix 2 export functionalities.
[misp-modules] Changes or creations of MISP modules
[validation]
[ACL] Changes or creations to the access control list mechanisms.
[Export] Changes or creations to the generic export modules.
[Feed Caching] Changes or creations to the feed cache mechanisms
[Distribution Graph]
[i18n Changes or additions to the i18n efforts of the MISP project (new translations etc.)
[doc] Changes or additions to the documentation efforts of MISP. Can be used for comments.
[tools] Changes or creations of any MISP related tools
[config] Changes or additions that touch on the configuration of MISP. Can be used to changed defaults.
[diag] Changes or additions that are related to the MISP diagnostics page.