documented commit message style
This commit is contained in:
parent
a6f4c7457d
commit
956a207ea7
|
@ -3,6 +3,7 @@
|
|||
|
||||
The following code style should be applied to the whole noxos codebase.
|
||||
Pull Requests that don't follow this code style will be rejected.
|
||||
Also commit messages have to fit the described format.
|
||||
|
||||
# Naming conventions
|
||||
- **structs** are suffixed with **_T**
|
||||
|
|
|
@ -0,0 +1,25 @@
|
|||
# Commit message style
|
||||
|
||||
Commit messages need to align with the following style:
|
||||
|
||||
`<type> (<space>): <change>`
|
||||
|
||||
## type
|
||||
The type of change to be committed.
|
||||
|
||||
Possible values:
|
||||
- __feature__
|
||||
- __fix__
|
||||
- __docs__
|
||||
- __refactor__
|
||||
|
||||
## space
|
||||
The space that is affected by the commit.
|
||||
|
||||
## change
|
||||
What you've changed. / The actual commit message.
|
||||
|
||||
# Examples
|
||||
- `feature (AHCI): implemented port initialization`
|
||||
- `fix (processes): changed process spawning to copy the null terminator at the end of the name`
|
||||
- `refactor (PS/2 keyboard): removed debug logs when handling cursor keys`
|
Loading…
Reference in New Issue