From 81cc0b678c09a3271fceef6b28560ca3bb49b4f8 Mon Sep 17 00:00:00 2001
From: Shidong Wang <wsdjeg@outlook.com>
Date: Thu, 14 Oct 2021 23:52:14 +0800
Subject: [PATCH] docs(dev): add commit style guide for breaking changes

---
 docs/development.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/development.md b/docs/development.md
index 64ad48ced..03d8bbbc7 100644
--- a/docs/development.md
+++ b/docs/development.md
@@ -177,6 +177,19 @@ therefore it is optional and only used when a commit requires a bit of explanati
 
 The footer is optional and is used to reference issue tracker IDs.
 
+
+**Breaking change**
+
+Breaking changes must be indicated by "!" after the type/scope, and
+a "BREAKING CHANGE" footer describing the change. Example:
+
+```
+refactor(tools#mpv)!: change default musics_directory
+
+BREAKING CHANGE: `~/Music` is standard on macOS and
+also on FreeDesktop's XDG.
+```
+
 ### Pull Request
 
 #### Prefix of title