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 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!!!

Comments

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 information of the stock. terminal-st

Setting up Nginx as a reverse proxy for Node.js App

Okay.. but what is a reverse proxy? A reverse proxy is a web server that centralizes internal services and provides unified interfaces to the public. Requests from clients are forwarded to a server that can fulfill it before the reverse proxy returns the server’s response to the client. Nginx is a popular choice to use as a reverse proxy for your node.js application. Got it. Now let’s set up Nginx Let’s say your nodejs server is running locally on localhost:3000. We will set up Nginx to get the request and forward the request to our nodejs server. Ins t alling Nginx on ubuntu sudo apt-get update sudo apt-get install nginx Configure Nginx Disable the default, virtual host unlink /etc/nginx/sites-enabled/default 2. Create a configuration file cd /etc/nginx/sites-available sudo nano reverse-proxy.conf 3. Put the following content in the file server { listen 80; listen [::]:80; access_log /var/log/nginx/reverse-access.log; error_log /var/log/nginx/reverse-e

Flutter: How to take Screenshot of the screen or widget and save as image

Introduction: In this post, we will discuss how to take a screenshot of the widget and save it as an image. Let’s take a use case where we need this functionality. Here is an app to read quotes in a beautiful background. quote app class MyHomePage extends StatefulWidget { MyHomePage({Key key}) : super(key: key); @override _MyHomePageState createState() => _MyHomePageState(); } class _MyHomePageState extends State<MyHomePage> { List<Quote> _quotes = [ Quote( content: "Friendship is Love without his wings!", author: "Lord Byron", image: 'quote-1.jpeg') ]; String _currentImage = 'assets/img/image1.jpeg'; initState() { super.initState(); } @override Widget build(BuildContext context) { return Scaffold( body: Stack( children: [ Container( decoration: BoxDecoration( image: DecorationImage( image: AssetImage('assets/img/placehol

Shashi Techlogues

Search This Blog