Good commit message V/S Bad commit message 🦾

Sourav Kumar — Tue, 16 Jul 2024 10:43:22 +0000

When developers are pushing their code to VCS(Version Control System) such as Git. If you are working in any industry for production level code.

One should learn to write better commit message and make it a habit so that it is easy for co-developers to understand the code just by seeing the commit message.

You can use git log command to check all the commit messages, I bet you will come to see “Yep… I have absolutely no idea what I meant by ‘Fix style’ 6 months ago.” that doesn’t make any sense, what is fixed, what is the issue. 🥴

Structure of Git commit message

Condensed

git commit -m <message>

Detailed

git commit -m <title> -m <description>

Tips for writing commit message

Use first letter as capital and rest as lowercase (title case).
Use type of commit message e.g. bugfix, error, refactor, bump, config.
Commit length of body must be 50 characters and description must be at least 72 characters.
Be specific, don’t use worked, developed, thought, rather be direct, “fix”.

The commit type can include the following:

feat – a new feature is introduced with the changes
fix – a bug fix has occurred
chore – changes that do not relate to a fix or feature and don't modify src or test files (for example updating dependencies)
refactor – refactored code that neither fixes a bug nor adds a feature
docs – updates to documentation such as a the README or other markdown files
style – changes that do not affect the meaning of the code, likely related to code formatting such as white-space, missing semi-colons, and so on
test – including new or correcting previous tests
perf – performance improvements
ci – continuous integration related
build – changes that affect the build system or external dependencies
revert – reverts a previous commit

Library v/s Framework

Sourav Kumar — Tue, 16 Jul 2024 10:41:54 +0000

Ever confused between library and frameworks ???

Do you also get confused about these two and used these two terms interchangeably.
Let me help you understand these two so you will have a better clarity.

First, lets start with definition:

Library

A collection of predefined methods, classes or interfaces used for solving common problems.
It comes either bundled with a language or can be downloaded from internet and used.

Examples - react.js, twilio, iText, apache commons and lot more.

Benefits of using library:

Reusability
Reduces programmer's effort
Allows programmer to focus on main problem

Framework

A collection of libraries is called framework, it provides a foundation on which we develop our code.
It provides pre-written common logics so that developers can focus on business logic only also called components.

Frameworks can be further divided into following sub categories:

Frontend framework
Web framework
Application Development framework
ORM framework

Examples - angular, spring, hibernate, struts and more.

Benefits of using framework:

Speeds up development process
The code is more secured than library
Forces developers to follow standard procedures and hence make our code clean and therefore is opinionated

Difference between library and framework

Libraries are lightweight whereas frameworks are more bulky.
Libraries are more flexible than frameworks.
Frameworks call our code whereas we developers call library methods or functions.
Frameworks employ the concept of IoC(Inversion of Control) where framework tells developers how to write the code.
Frameworks controls the flow of application but we can use force library to control the flow of application.
Libraries are more flexible than frameworks.

Conclusion

I hope you know the difference and advantages and disadvantages of using libraries and frameworks 🏗️.
If, you want to develop overall architecture of an application by using best practices and standards, you can use framework but if you want to develop application at a greater pace with your own custom logics and control flow on your own, you can use library 📚.

Follow me on Twitter for more.

Forem: Sourav Kumar