[GH-ISSUE #411] improve revert example #4856

New Issue

GiteaMirror · 2026-05-02T23:27:19-05:00

GiteaMirror commented

2026-05-02 23:27:19 -05:00

Originally created by @privatenumber on GitHub (Nov 8, 2021).
Original GitHub issue: https://github.com/conventional-commits/conventionalcommits.org/issues/411

Description

The example set for the "revert" type can be improved:

118d24b0ca/content/v1.0.0/index.md (L193)

revert: let us never again speak of the noodle incident

Refs: 676104e, a215868

This is a poor example because it doesn't follow the format of Conventional Commits:

<type>[optional scope]: <description>

The "description" let us never again speak of the noodle incident is not a description of the commit, but rather some obscure inside joke/reference that provides no immediate insight to new contributors that are trying to skim a commit log.

Proposal

Change to something like:

revert: broken gallery feature

Refs: 676104e, a215868

Originally created by @privatenumber on GitHub (Nov 8, 2021). Original GitHub issue: https://github.com/conventional-commits/conventionalcommits.org/issues/411 ## Description The example set for the "revert" type can be improved: https://github.com/conventional-commits/conventionalcommits.org/blob/118d24b0ca7822493fc4beb97451b0249ae9b4e1/content/v1.0.0/index.md?plain=1#L193 > revert: let us never again speak of the noodle incident > > Refs: 676104e, a215868 This is a poor example because it doesn't follow the format of Conventional Commits: ``` <type>[optional scope]: <description> ``` The "description" `let us never again speak of the noodle incident` is not a description of the commit, but rather some obscure inside joke/reference that provides no immediate insight to new contributors that are trying to skim a commit log. ## Proposal Change to something like: > revert: broken gallery feature > > Refs: 676104e, a215868

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#4856