tags for commit message for better understandability

commit-message-examples.md

one simple tag may mean a lot...

Commit Message Tags

• [feat]/[feat-impl]: New Feature Implementation - implementing new feature/functionality
• [enhnc]: Enhancement - adding more functionality to existing feature
• [req]/[req-chng]: Requirement Change - introducing requirement change, doing something in a different way
• [fix]/[bug-fix]: Bug Fix - patch fixing bug/issue/defect
• [refact]: Refactoring - code refactoring, like- name, indentation, formatting, spacing, code-block removal, etc.
• [config]: Changing Configuration - changing build confuration, or external dependencies, or libraries, etc.
• [doc]: Documentation - adding project documentation/comment
• [test]: Test - adding/removing/correcting tests, like- unittest

Examples

[feat-impl] add file read-write support

[feat-impl] add ServerConfiguration

[feat-impl] add authorization through tenant-id and token

[enhnc] support for easy gui resization

[req-chng] json time format for communication changed

[req-chng] 'USERID' is an auto field in ZKAccess DB, so need to use 'Badgenumber' from 'USERINFO' table instead for communicating with server.

[bug-fix] was sending wrong data to the server

[refact] extracted ConfigurationManagerAIS from ConfigurationManager, and renamed DataSender to Communicator

[doc] add developer info

[doc] adding installation instruction to readme

(some bad/good commit messages, accompanied by great tags ;) )

There are times- we abruptly write commit messages just to get the project running; and suffer a lot later while maintaining. A small tag may prove to be a life saver.