Commit Messages
What is a Commit Message?
Commit messages within a Version Control System (VCS) create documentation and quick insight into changes made to production level code. An effective commit message enables members of a data team to understand what changes were made and why without having to look at the code itself. This is super valuable when you want a birds eye view of production level code. Unfortunately, this doesn't happen by default. So how do you ensure your teams generate effective commit messages?
Standardizing Commit Messages
Standardizing commit messages is the only way to ensure consistency among your teams. Without it, commit messages will vary from person to person. Some people may write too much, others may write too little. Creating a standardized template ensures the right amount of information is conveyed and gives new employees clear direction on what needs to be included in their messages. In working with data teams in the past, we have found the following template to be helpful in writing effective commit messages.
Recommended Commit Message
[ADDED | UPDATED | RENAMED | DELETED | ALTERED] [FILENAME(S)]
Details go here
Example
Updated app.py
Added new python functions.