-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathCONTRIBUTING
More file actions
56 lines (40 loc) · 1.27 KB
/
CONTRIBUTING
File metadata and controls
56 lines (40 loc) · 1.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# Conventional Commits
All commit messages MUST follow the Conventional Commits specification:
**Format:**
```
<type>: <description>
[optional body]
[extra <type>: <description>]
[BREAKING CHANGE: <description>]
[optional co-authors(s) (Can be human or AIs)]
```
**Required Types:**
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation changes
- `perf`: Performance improvement
- `refactor`: Code refactoring (no functional changes)
- `test`: Adding or updating tests
- `chore`: Maintenance tasks (excluded from changelog)
- `style`: Code style changes (excluded from changelog)
**Rules:**
- Type MUST be lowercase
- Colon and space MUST follow the type
- Description MUST be present, concise, and imperative mood
- Description MUST NOT end with a period
- Optional scope can be added: `feat(auth): Add OAuth2 support`
- Breaking changes: Add `BREAKING CHANGE:` in footer
**Examples:**
```
feat: Add passkey authentication support
fix: Resolve MFA validation timing issue
docs: Update web platform setup instructions
perf: Optimize GraphQL query caching
```
**Complex example:**
```feat: Added new things!
Enhancements on something
fix: Fixed some bugs
Co-authored-by: Kenny Mochizuki <PHKenny@users.noreply.github.com>
Co-authored-by: AI Assistant <no-reply@ai.com>
```