aiven-client icon indicating copy to clipboard operation
aiven-client copied to clipboard

[Docs] Minor suggestion for ensuring good quality commit messages

Open mickeypash opened this issue 2 years ago • 0 comments

What is currently missing?

I noticed that in your CONTRIBUTING guide you reference Chris Beam's blogpost. However there is currently no way to encourage/enforce these suggested practices.

How could this be improved?

A simple solution would be to use a commit message template. It can be part of this repository. Here's how it could work:

  • We would add a new file called .gitmessage
  • It would contain the template below.
  • The CONTRIBUTING.md would contain the following

With git command :

$ git config commit.template .gitmessage

Or by adding in the config file the following lines :

[commit]
  template = .gitmessage

Git commit message template .gitmessage

# Title: Summary, imperative, start upper case, don't end with a period
# No more than 50 chars. #### 50 chars is here: #

# Remember blank line between title and body.

# Body: Explain *what* and *why* (not *how*). Include task ID (Jira issue).
# Wrap at 72 chars. ################################## which is here: #


# At the end: Include Co-authored-by for all contributors. 
# Include at least one empty line before it. Format: 
# Co-authored-by: name <[email protected]>
#
# How to Write a Git Commit Message:
# https://chris.beams.io/posts/git-commit/
#
# 1.Separate subject from body with a blank line
# 2. Limit the subject line to 50 characters
# 3. Capitalize the subject line
# 4. Do not end the subject line with a period
# 5. Use the imperative mood in the subject line
# 6. Wrap the body at 72 characters
# 7. Use the body to explain what and why vs. how
EOF

Is this a feature you would work on yourself?

[X] I plan to open a pull request for this feature

mickeypash avatar Jan 31 '23 23:01 mickeypash