[PR #402] [MERGED] docs: improve example #4556

New Issue

GiteaMirror · 2026-04-27T16:09:37-05:00

GiteaMirror commented

2026-04-27 16:09:37 -05:00

📋 Pull Request Information

Original PR: https://github.com/conventional-commits/conventionalcommits.org/pull/402
Author: @shaman-apprentice
Created: 10/3/2021
Status: ✅ Merged
Merged: 10/5/2021
Merged by: @damianopetrungaro

Base: master ← Head: docs/348/multi-paragraph-example

📝 Commits (2)

179f675 docs: improve example
1e0a8c4 docs: use "fix" type for example

📊 Changes

12 files changed (+72 additions, -48 deletions)

View changed files

📝 content/next/index.md (+6 -4)
📝 content/v1.0.0/index.de.md (+6 -4)
📝 content/v1.0.0/index.fr.md (+6 -4)
📝 content/v1.0.0/index.id.md (+6 -4)
📝 content/v1.0.0/index.ja.md (+6 -4)
📝 content/v1.0.0/index.ko.md (+6 -4)
📝 content/v1.0.0/index.md (+6 -4)
📝 content/v1.0.0/index.ru.md (+6 -4)
📝 content/v1.0.0/index.th.md (+6 -4)
📝 content/v1.0.0/index.uk.md (+6 -4)
📝 content/v1.0.0/index.zh-hans.md (+6 -4)
📝 content/v1.0.0/index.zh-hant.md (+6 -4)

📄 Description

Thanks for all your input in #348. I mostly agree with you.

I think whether to start header capitalized or not is opinionated, as long as it is consistent. I find it more natural to capitalize it but e.g. Angular conventions states, it must not be capitalized. So I will leave it out of this PR. Changing it in all examples would anyway be worth an own issue and pull request in my opinion.

I felt given a shortened abstract example is nicer to read than quoting Chris Beam's exmaple.

As a side note regarding "Issues trackers can change over time". I think they shouldn't as they contain important information from also non technical stakeholders. But that's a completely different discussion :)

Thanks again for all your input! I am happy about further input.

Close #348

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/conventional-commits/conventionalcommits.org/pull/402 **Author:** [@shaman-apprentice](https://github.com/shaman-apprentice) **Created:** 10/3/2021 **Status:** ✅ Merged **Merged:** 10/5/2021 **Merged by:** [@damianopetrungaro](https://github.com/damianopetrungaro) **Base:** `master` ← **Head:** `docs/348/multi-paragraph-example` --- ### 📝 Commits (2) - [`179f675`](https://github.com/conventional-commits/conventionalcommits.org/commit/179f675ab470cbbb0aa2bc1ad76ce9f22396b848) docs: improve example - [`1e0a8c4`](https://github.com/conventional-commits/conventionalcommits.org/commit/1e0a8c4f0f45759e6b49817a4816db147e754186) docs: use "fix" type for example ### 📊 Changes **12 files changed** (+72 additions, -48 deletions) <details> <summary>View changed files</summary> 📝 `content/next/index.md` (+6 -4) 📝 `content/v1.0.0/index.de.md` (+6 -4) 📝 `content/v1.0.0/index.fr.md` (+6 -4) 📝 `content/v1.0.0/index.id.md` (+6 -4) 📝 `content/v1.0.0/index.ja.md` (+6 -4) 📝 `content/v1.0.0/index.ko.md` (+6 -4) 📝 `content/v1.0.0/index.md` (+6 -4) 📝 `content/v1.0.0/index.ru.md` (+6 -4) 📝 `content/v1.0.0/index.th.md` (+6 -4) 📝 `content/v1.0.0/index.uk.md` (+6 -4) 📝 `content/v1.0.0/index.zh-hans.md` (+6 -4) 📝 `content/v1.0.0/index.zh-hant.md` (+6 -4) </details> ### 📄 Description Thanks for all your input in #348. I mostly agree with you. I think whether to start header capitalized or not is opinionated, as long as it is consistent. I find it more natural to capitalize it but e.g. [Angular conventions](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit-message-header) states, it must not be capitalized. So I will leave it out of this PR. Changing it in all examples would anyway be worth an own issue and pull request in my opinion. I felt given a shortened abstract example is nicer to read than quoting [Chris Beam's exmaple](https://chris.beams.io/posts/git-commit/#why-not-how). As a side note regarding *"Issues trackers can change over time"*. I think they shouldn't as they contain important information from also non technical stakeholders. But that's a completely different discussion :) Thanks again for all your input! I am happy about further input. Close #348 --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-27 16:09:37 -05:00

GiteaMirror closed this issue

2026-04-27 16:09:42 -05:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/conventionalcommits.org#4556