Skip to main content

Posts

Showing posts with the label Programmer

Level up your git commit messages

What is a commit message? In short, a git commit records changes to a repository. Why a good commit message? Easier to review & identify potential flaws. Easier to do cherry-pick ( https://www.previousnext.com.au/blog/intro-cherry-picking-git ). To help future developers. How to write a good commit message? One commit for one “logical change” Include module/feature name enclosed in [ ] Followed by a type of commit Followed by a meaningful and descriptive message Do include Jira bug id if the commit is fixing an issue Do include ticket id if it’s a new feature Example: git commit -m “[Module] type #id message” git commit -m “[Notifications] fix #3367 Fix unread notification count” Types of commit messages: build : Changes that affect the build system or external dependencies ci : Changes to CI configuration files and scripts docs : Documentation only changes feature : A new feature fix : A bug fix perf : A code change that improves performance refactor : A code change that neither f...