github-starred/conventionalcommits.org
2
0
Fork 0
mirror of https://github.com/conventional-commits/conventionalcommits.org.git synced 2026-03-22 12:44:37 -05:00
Code Issues 153 Packages Projects Releases Wiki Activity

Add clarification for description formatting #200

New Issue
Open
opened 2026-02-17 11:53:16 -06:00 by GiteaMirror · 0 comments
GiteaMirror commented 2026-02-17 11:53:16 -06:00
Owner
Copy Link

Originally created by @echasnovski on GitHub (Feb 27, 2024).

Currently the only rule for description is "A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.".

Besides "be short", there is no specification on its formatting. I would like to suggest expanding this with (at least) two rules which are already followed in all examples and most real world usages:

  • First word MUST NOT be capitalized.
  • MUST NOT end with punctuation.

If any of this is a welcome change, I am happy to do a PR.

Originally created by @echasnovski on GitHub (Feb 27, 2024). Currently the only rule for description is "A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_.". Besides "be short", there is no specification on its formatting. I would like to suggest expanding this with (at least) two rules which are already followed in all examples and most real world usages: - First word MUST NOT be capitalized. - MUST NOT end with punctuation. If any of this is a welcome change, I am happy to do a PR.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
discussion
enhancement
greenkeeper
help wanted
meeting-agenda
operations
process
pull-request
Mirrored from GitHub Pull Request
 question
suggestion
support
triaged
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
GiteaMirror ninjasurge
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#200
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?