summaryrefslogtreecommitdiff
path: root/COMMIT.MD
blob: 20d8f6cd896754385829a553bc7c248b618b83d0 (plain)
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# Commit Message Guide

BSDOS follows the Conventional Commits specification.

## Format

```
<type>(<scope>): <short description>
```

Examples:

```
feat(kernel): implement scheduler initialization
fix(vfs): resolve inode reference leak
docs(readme): update project goals
refactor(mm): simplify page allocator
test(libc): add string function tests
build(toolchain): update compiler flags
chore(ci): add formatting workflow
```

---

## Commit Types

### feat

A new feature.

```
feat(kernel): add process scheduler
feat(net): implement UDP sockets
```

### fix

A bug fix.

```
fix(vm): prevent page table corruption
fix(fs): correct FAT directory parsing
```

### docs

Documentation only.

```
docs(readme): add build instructions
docs(api): document syscall interface
```

### style

Formatting changes only.

```
style(kernel): format scheduler source
```

### refactor

Code improvements without changing behavior.

```
refactor(vfs): simplify path resolution
```

### perf

Performance improvements.

```
perf(mm): optimize slab allocator lookup
```

### test

Adding or improving tests.

```
test(kernel): add scheduler unit tests
```

### build

Changes affecting the build system or dependencies.

```
build(toolchain): support Clang 19
build(make): improve release target
```

### ci

Continuous Integration changes.

```
ci(github): add build workflow
```

### chore

Miscellaneous maintenance.

```
chore: update .gitignore
chore: bump version number
```

### revert

Reverting a previous commit.

```
revert: feat(kernel): add scheduler initialization
```

---

## Common Scopes

```
kernel
boot
arch
x86
amd64
arm64
mm
vm
vfs
fs
net
ipc
proc
sched
drivers
pci
usb
acpi
libc
userland
shell
build
toolchain
docs
tests
ci
```

---

## Rules

- Use the imperative mood.
- Keep the subject under ~72 characters.
- Do not end the subject with a period.
- Make one logical change per commit.
- Reference issues in the commit body when applicable.

Good:

```
feat(kernel): add round-robin scheduler
fix(vfs): prevent null pointer dereference
docs(readme): document coding standards
```

Bad:

```
fixed stuff
update
changes
misc fixes
```