Skip to content

Commit fbeabc4

Browse files
chore(rules): remove spec link from conventional-commits
1 parent b91e78c commit fbeabc4

File tree

1 file changed

+66
-0
lines changed

1 file changed

+66
-0
lines changed
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: Use Conventional Commits format for all commit messages
3+
alwaysApply: true
4+
---
5+
6+
# Conventional Commits
7+
8+
## Format
9+
10+
```
11+
<type>[optional scope]: <description>
12+
13+
[optional body]
14+
15+
[optional footer(s)]
16+
```
17+
18+
## Types
19+
20+
| Type | Use when |
21+
|------|----------|
22+
| `feat` | Adding a new feature (MINOR in SemVer) |
23+
| `fix` | Patching a bug (PATCH in SemVer) |
24+
| `docs` | Documentation only |
25+
| `style` | Formatting, whitespace, no code change |
26+
| `refactor` | Code change that neither fixes a bug nor adds a feature |
27+
| `perf` | Performance improvement |
28+
| `test` | Adding or updating tests |
29+
| `build` | Build system or dependencies |
30+
| `ci` | CI configuration |
31+
| `chore` | Other changes (maintenance, tooling) |
32+
33+
## Scope
34+
35+
Optional. Use a noun describing the affected area in parentheses: `feat(auth):`, `fix(api):`.
36+
37+
## Examples
38+
39+
```
40+
feat: add user registration endpoint
41+
```
42+
43+
```
44+
fix(login): prevent redirect loop on session expiry
45+
```
46+
47+
```
48+
chore(hooks): rename run-quality-checks to run-phpstan-on-stop
49+
```
50+
51+
```
52+
docs: correct spelling of CHANGELOG
53+
```
54+
55+
```
56+
feat(api)!: drop support for deprecated endpoints
57+
58+
BREAKING CHANGE: /v1/users has been removed. Use /v2/users instead.
59+
```
60+
61+
## Rules
62+
63+
- Description is required and MUST immediately follow the type/scope.
64+
- Use imperative mood: "add feature" not "added feature".
65+
- No period at the end of the description.
66+
- Use `!` after type/scope or `BREAKING CHANGE:` in footer for breaking changes.

0 commit comments

Comments
 (0)