google / google/xls

Document and settle on a commit message convention

Open
#1,381 0 comments 0 reactions 0 assignees View on GitHub
build cleanup documentation
Dominant language
C++
Stars
1.9k
Forks
283
Avg merge
2d 10h
Merged PRs (30d)
135

Description

Currently it seems that we use different conventions for public commit messages in this repository:
- @cdleary tend to use `[Subsystem:Sub subsystem][downcase(Type of change)] Message`
- @proppy tend to use `subdirectory: message`
- other contributors tend to use `Message`

In general `Message` start with an action verb like `Add`, `Fix`, `Update` or `Improve`.

It would be nice to settle on a unified convention like @cdleary's or re-use well established one like https://www.conventionalcommits.org/.

That would also help w/ things like #1380 and can also be enforced with pre-submit github actions.

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.