Our current project consists of multiple modules in
/modules/. When I work on my current module and i.e. update its
README how should I write a commit message for this?
Update README in module_XYZ
Update README [module_XYZ]
module_XYZ | Update README
- Something else?
I think 1. has too less information since the single modules are all structured similar - hence this would be ambiguous. 2 - 4 seem to be better but this means I would always need to add the modulename to the commit message which is somehow redundant, since the actual commit shows which module (file) is affected.
I've read this nice How to Write a Git Commit Message post but it does not mention how to write which module your commit affects.