diff --git a/codestyle.md b/codestyle.md index 2f41b26..ed0b701 100644 --- a/codestyle.md +++ b/codestyle.md @@ -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** diff --git a/commit-format.md b/commit-format.md new file mode 100644 index 0000000..3999394 --- /dev/null +++ b/commit-format.md @@ -0,0 +1,25 @@ +# Commit message style + +Commit messages need to align with the following style: + +` (): ` + +## 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` \ No newline at end of file