mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-05-24 06:40:53 -05:00
[PR #139] [MERGED] docs: use imperative mood in descriptions #2960
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
📋 Pull Request Information
Original PR: https://github.com/conventional-commits/conventionalcommits.org/pull/139
Author: @bjorn-helgaas
Created: 4/3/2019
Status: ✅ Merged
Merged: 4/10/2019
Merged by: @bcoe
Base:
master← Head:imperative📝 Commits (1)
c0308e8docs: use imperative mood in descriptions📊 Changes
1 file changed (+2 additions, -2 deletions)
View changed files
📝
content/next/index.md(+2 -2)📄 Description
Conventional Commits is silent on the grammatical structure of commit
descriptions, but logs are easier to read if that structure is consistent.
Convert the examples to imperative mood so they all read similarly:
allow provided config object to extend other configs
correct spelling of CHANGELOG
add polish language
correct minor typos in code
More discussion of the topic:
https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
https://chris.beams.io/posts/git-commit/
🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.