[PR #64] [CLOSED] BREAK: feat: indicate breaking changes in header via "BREAK: " prefix #273

New Issue

GiteaMirror · 2026-02-17T11:56:56-06:00

GiteaMirror commented

2026-02-17 11:56:56 -06:00

📋 Pull Request Information

Original PR: https://github.com/conventional-commits/conventionalcommits.org/pull/64
Author: @apetro
Created: 7/5/2018
Status: ❌ Closed

Base: master ← Head: breaking-prefix

📝 Commits (1)

bd607fc BREAK: feat: indicate breaking changes in header via "BREAK: " prefix

📊 Changes

1 file changed (+10 additions, -1 deletions)

View changed files

📝 index.md (+10 -1)

📄 Description

BREAKING CHANGE: adds new "BREAK: " prefix before type in header in commits including breaking API changes. Tools written to the spec before this feature may fail to parse or flag as non-compliant commit messages using this feature. Breaking change commit messages written to prior versions of this spec will not be compliant with versions of the spec with this change.

Tools can regain spec compliance by adding support for parsing the new "BREAK: " prefix.

For a commit that includes API-breaking changes, that fact is the most important thing to say about the commit, so lead with it in the commit message header. Indicating breakingness in the commit message header makes API breakages more apparent on skim in more contexts.

_{🔄 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/64 **Author:** [@apetro](https://github.com/apetro) **Created:** 7/5/2018 **Status:** ❌ Closed **Base:** `master` ← **Head:** `breaking-prefix` --- ### 📝 Commits (1) - [`bd607fc`](https://github.com/conventional-commits/conventionalcommits.org/commit/bd607fc95611c20813f2cd43c6e8f2e9cdd74af3) BREAK: feat: indicate breaking changes in header via "BREAK: " prefix ### 📊 Changes **1 file changed** (+10 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `index.md` (+10 -1) </details> ### 📄 Description BREAKING CHANGE: adds new "BREAK: " prefix before type in header in commits including breaking API changes. Tools written to the spec before this feature may fail to parse or flag as non-compliant commit messages using this feature. Breaking change commit messages written to prior versions of this spec will not be compliant with versions of the spec with this change. Tools can regain spec compliance by adding support for parsing the new "BREAK: " prefix. For a commit that includes API-breaking changes, that fact is the most important thing to say about the commit, so lead with it in the commit message header. Indicating breakingness in the commit message header makes API breakages more apparent on skim in more contexts. --- <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-02-17 11:56:56 -06:00

GiteaMirror closed this issue

2026-02-17 11:56:58 -06: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#273