Git best practices for commit message

Certainly! Writing a good commit message is essential for maintaining a clean and understandable version history.

The Anatomy of a Good Commit Message

Short, Descriptive Title (50 characters or less)

A more detailed explanation of the changes in the commit.
This can span multiple lines and should provide context
and background information as needed.

- Bullet points can be used to list specific changes or
  features added or removed.
- Be concise but informative.
- Mention relevant issues or references if applicable.

Fixes #
Here are some guidelines for creating effective commit messages:

Short Title: Keep the title concise and to the point. It should be under 50 characters and summarize the essence of the commit.

Detailed Explanation: In the body of the message, provide a more detailed explanation of what the commit does, why it's necessary, and any background information that might be helpful. Use multiple lines if needed.

Bullet Points: You can use bullet points to list specific changes, features added, or bugs fixed in the commit. This helps make the changes more understandable.

Reference Issues: If your commit is related to a specific issue or task, reference it using the "Fixes #1234" or "Closes #5678" format. This helps with issue tracking and integration with project management tools.

Be Consistent: Maintain a consistent style and format for your commit messages across your project or team to ensure clarity and readability.

Real-Life Examples 
Here are a few important short titles that I use regularly.
// Use past tense for commit message.
1. feat - new feature
2. fix - bug fix
3. docs - changes in documentation
4. style - everything related to styling
5. refactor - code changes that neither fixes a bug or add new features
6. test - everything related to testing
7. chore - updating build task, package manager configs etc..
You can come up with your own pattern which suits your team or project. 

In summary, Git commit messages are crucial for collaborative software development. By following best practices, you can create a clear and informative project history that enhances your development workflow and teamwork. Happy coding!

Comments

Post a Comment

Popular posts from this blog

Formatting MySQL Dates

Image
MySQL's DATE_FORMAT() function provides a wide range of format codes that you can use to represent date and time values in various formats.  It allows you to format a date or datetime value as a string using custom formatting. DATE_FORMAT(date, format) date: The date or datetime value you want to format. format: A string specifying the desired format for the output. This string can include special format codes that represent various components of the date and time (e.g., %Y for the year, %m for the month, %d for the day, %H for the hour, %i for the minute, %s for the second, etc.). SELECT DATE_FORMAT('2023-09-03', '%M %d, %Y'); // returns 'September 03, 2023'. Here is a list of commonly used format codes along with examples: %Y: Four-digit year (e.g., '2023'). %y: Two-digit year (e.g., '23' for 2023). %m: Month (01-12). %c: Month (1-12). %d: Day of the month (01-31). %e: Day of the month (1-31). %H: Hour (00-23). %h: Hour (01-12). %I: Hou...
Read more

SOAP Explained: With Javascript

What is SOAP? SOAP is like a set of rules that helps different computer programs talk to each other. Imagine you have two friends who speak different languages. SOAP is like a universal translator that helps them understand each other. Now, when these programs talk, they use a special type of text called XML. It's like a format that's easy for both programs to read, like having a conversation in a language that both friends understand. So, SOAP is kind of like a language translator for computers, and XML is the language they use to communicate. This way, even if two programs are running on completely different systems, they can still understand each other and share information. SOAP Request A SOAP request consists of a SOAP envelope that contains the SOAP header and the SOAP body. Here's a basic example of what a simple XML request in SOAP might look. <?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope     xmlns:soapenv="http://schemas...
Read more