Skip to content

Git Commit Message Guidelines #1048

Description

@canabady

Suggested link

How to Write a Git Commit Message

Reasoning

The article How to Write a Git Commit Message by Chris Beams is a widely recommended guide for writing clear and effective Git commit messages.

The page explains seven practical rules for structuring commit messages, including keeping the subject line concise (around 50 characters), separating the subject from the body with a blank line, using the imperative mood (e.g., “Fix bug” instead of “Fixed bug”), and wrapping the body text at about 72 characters. It also emphasizes that the commit message body should explain what changed and why, rather than describing how the code was implemented.

This resource is helpful because well-written commit messages improve collaboration and maintainability. They allow developers and reviewers to quickly understand the purpose of changes, browse project history more easily, and make better decisions when debugging or modifying code in the future.

In short, the guide provides simple conventions that make project history readable and meaningful for both current contributors and future developers.

Section

Contributing to Open Source in general

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions