Skip to main content

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?

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:

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 fixes a bug nor adds a feature

style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)

test: Adding missing tests or correcting existing tests

Things to avoid when creating commits:

  • Mixing two unrelated functional changes.
  • Sending large new features in a single giant commit.

It may well be the case that the code for a new feature is only useful when all of it is present. This does not, however, imply that the entire feature should be provided in a single commit. New features often entail refactoring existing code. It is highly desirable that any refactoring is done in commits which are separate from those implementing the new feature. This helps reviewers and test suites validate that the refactoring has no unintentional functional changes. Even the newly written code can often be split up into multiple pieces that can be independently reviewed.

References:

Happy Coding!!! 

Labels:

Comments

Post a Comment

Popular posts from this blog

Visualising Your Google Location History

Step 1: Download Your Google Location History First, you need to download your location history data from Google. Follow these steps to get started: Go to Google Takeout : Visit Google Takeout to begin the process. Select Location History (Timeline) : Make sure to select the “Location History (Timeline)” option. 3. Export Your Data : Google will compile your data, which might take some time. You will receive an email once your data is ready to be downloaded. 4. Download the Data : Follow the instructions in the email to download your data. Step 2: Extract the Downloaded File Once you’ve downloaded your data, locate the file and extract it. The location data will be in a JSON file at the following path: takeout-202XXXXXTXXXXXXZ-001/Takout/Location History (Timeline)/Records.json Step 3: Convert JSON to CSV To make the location data usable, we need to convert it from JSON to CSV format. Although you can convert it to KML or geoJSON formats, we’ll focus on CSV for this post. 1.  Clon...
Post a Comment
Read more

Track stock market information right in your Terminal.

     Introduction: As a developer, I love working with the terminal. The plain, simple, and in my opinion the best way to interact with the computer (also it makes you look geeky). I spent most of my time in the terminal. By now you must have guessed I am a huge fan of the terminal and terminal-based applications. Recently I developed an interest in stock markets and started tracking the stock markets. Since I love working with the terminal I decided to build a terminal oriented application that can help me to track the stock market. Inspir e d by  wttr.in  I build  terminal-stocks  which can provide the stock's current prices, historical prices, and global market summary. How to use terminal-stocks terminal-stocks  is available and can be used without installation. Get the current price of the stock. curl terminal-stocks.dev/ITC.NS Current price of stocks You need to provide the ticker of the stock and terminal-stocks will give you the price inf...
Post a Comment
Read more

Unleashing the Power of Personal Photo Management with PhotoPrism

As an avid photographer and a lover of memories, I've always struggled with managing and organizing my ever-growing collection of digital photos. It was a constant battle to find specific photos, especially as I often forget to tag or rename them. That's when I stumbled upon PhotoPrism , a powerful open-source photo management tool that has revolutionized the way I interact with my photo library. In this blog post, I'll guide you through the process of installing and using PhotoPrism, sharing my personal use cases along the way. Whether you're a professional photographer, a hobbyist, or simply someone passionate about preserving memories, PhotoPrism is a game-changer. Getting Started To start our journey with PhotoPrism, the first step is to install it. Head over to the official repository on GitHub and follow the installation instructions provided there. Don't worry, the installation process is well-documented and straightforward, making it accessible even for no...
3 comments
Read more