InsightSoftwareConsortium / InsightSoftwareConsortium/ITK

Enforce writing commit message bodies

Open
#4,218 0 comments 0 reactions 0 assignees View on GitHub
type:Infrastructure
Dominant language
C++
Stars
1.7k
Forks
748
Avg merge
1d 1h
Merged PRs (30d)
64

Description

### Description

Frequently contributors do not write a commit message body, and it becomes difficult to see the rationale or benefit of the change, or the reason why a particular approach was chosen.

### Impact analysis

Not writing a commit message body makes it difficult to understand past changes when navigating the git history, and any relevant exchange may remain only on the GitHub comments.

### Expected behavior

We should enforce e.g. through a pre-commit hook writing a commit message body.

### Actual behavior

Commit message bodies can be empty.

### Versions

`master`.

### Environment

Any.

### Additional Information

Although we cannot ensure self-contained, complete message bodies, this will at least avoid empty commit message bodies.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.