Skip to content

Commit 8bb8382

Browse files
committed
📖 docs: update commit message guidelines for breaking changes
1 parent 6e3e0bd commit 8bb8382

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

.github/instructions/copilot.instructions.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ Reference: https://github.com/wgtechlabs/clean-commit
1313
```text
1414
<emoji> <type>: <description>
1515
<emoji> <type> (<scope>): <description>
16+
<emoji> <type>!: <description>
17+
<emoji> <type>! (<scope>): <description>
1618
```
1719

1820
## The 9 Types
@@ -32,6 +34,7 @@ Reference: https://github.com/wgtechlabs/clean-commit
3234
## Rules
3335

3436
- Use lowercase for type
37+
- Use `!` immediately after type (no space) to signal a breaking change — only for `new`, `update`, `remove`, `security`
3538
- Use present tense ("add" not "added")
3639
- No period at the end
3740
- Keep description under 72 characters
@@ -47,3 +50,5 @@ Reference: https://github.com/wgtechlabs/clean-commit
4750
- `🧪 test: add unit tests for auth service`
4851
- `📖 docs: update installation instructions`
4952
- `🚀 release: version 1.0.0`
53+
- `📦 new!: completely redesign authentication system`
54+
- `🔧 update! (api): change response format for all endpoints`

AGENTS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Reference: https://github.com/wgtechlabs/clean-commit
99
```text
1010
<emoji> <type>: <description>
1111
<emoji> <type> (<scope>): <description>
12+
<emoji> <type>!: <description>
13+
<emoji> <type>! (<scope>): <description>
1214
```
1315

1416
## The 9 Types
@@ -28,6 +30,7 @@ Reference: https://github.com/wgtechlabs/clean-commit
2830
## Rules
2931

3032
- Use lowercase for type
33+
- Use `!` immediately after type (no space) to signal a breaking change — only for `new`, `update`, `remove`, `security`
3134
- Use present tense ("add" not "added")
3235
- No period at the end
3336
- Keep description under 72 characters
@@ -43,3 +46,5 @@ Reference: https://github.com/wgtechlabs/clean-commit
4346
- `🧪 test: add unit tests for auth service`
4447
- `📖 docs: update installation instructions`
4548
- `🚀 release: version 1.0.0`
49+
- `📦 new!: completely redesign authentication system`
50+
- `🔧 update! (api): change response format for all endpoints`

0 commit comments

Comments
 (0)